Редактор для конечной документации пользователя в приложении C # WinForm

Question

Я разрабатываю приложение Winform в C # 4.0 и хотелось бы, чтобы другие (не разработчики) коллеги пожелаете вносить вклад в письменном виде контекстно-чувствительного HELP-пользователей. Сначала я подумал, что смогу использовать «семинар HTML Help» от Microsoft, но кажется устаревшим (Vista и Windows 7 не поддерживается). Затем я посмотрел на Sandcastle, но документация не хватает, и мне интересно, подходит ли она для нетехнологичных пользователей для записи документации с конечной пользователем. Поэтому я прочитал о Robohelp, но это путь для меня дорого. Я теряюсь во всей информации, которая доступна о HELPFILES. Может кто-нибудь помочь дать несколько лучших практик или информацию о том, какие инструменты использовать и какой формат вывода я должен нацелить (все еще CHM или другое).

Answer 1

Отличный вопрос. Мне нравится ваша идея не разработчиков, способствующих конечной документации.

Эта идея может мотивировать пользователей и тестеров вашего приложения, чтобы легко внести вклад в документацию.

Первое, что приходит на мой взгляд, использует какой-то двигатель Wiki. Вы можете создать простую функцию в вашем приложении WinForm, который выпускает браузер и направляет в Wiki. Вы можете использовать контекст, из которого он вызывается для создания URL; например http://dev-wiki.mycompany.com/LoginForm?action=edit. Отказ Здесь имя формы («loginform») используется в URL страницы Wiki.

Кроме того, вы можете просто использовать встроенный Управление веб-браузером для WinForms для доступа к Wiki. Это будет выглядеть что-то вроде:

var url = GetWikiUrl(myForm);
browserControl.Navigate(url);

Это было бы очень легко встроить в вашу заявку.

В контролируемой (офисной) среде это было бы очень легко настроить. В вашей производственной среде это может быть немного сложнее, но все еще выполнена. Это может использовать некоторые вклады в конечном пользователю.

Answer 2

Для написания документации я использую сфинксОтказ Он позволяет вам документировать в простом тексте и имеет различные выходные форматы (CHM, HTML, PDF и т. Д.).

Некоторые из них (CHM, HTML) могут использоваться в качестве контекстно-чувствительных источников справки.

Однако простой пользовательский интерфейс SPHINX (текстовый редактор и файл Make) может не подходить для нетехнических пользователей.

Answer 3

Я бы порекомендовал использовать Помощь + руководство для создания документации CHM. Это похоже на MS Word, и любой пользователь ПК может начать вносить разработку DOC после короткого образования. Но этот инструмент не бесплатный :(