Редактор документации для конечных пользователей в приложении C# WinForm
Я занимаюсь разработкой приложения WinForm на языке C# 4.0 и хотел бы, чтобы другие коллеги (не разработчики) внесли свой вклад в написание контекстно-зависимой справки для конечных пользователей. Сначала я подумал, что могу использовать "HTML Help Workshop" от Microsoft, но он выглядит устаревшим (Vista и Windows 7 не поддерживаются). Затем я посмотрел на Sandcastle, но документации не хватает, и мне интересно, подходит ли это для нетехнических пользователей для написания документации для конечных пользователей. Так что я читал о RoboHelp, но это дорогой для меня путь. Я теряюсь во всей информации, которая доступна о файлах помощи. Может кто-нибудь помочь дать некоторые лучшие практики или информацию о том, какие инструменты использовать и какой выходной формат я должен выбрать (все еще chm или другой).
3 ответа
Отличный вопрос Мне нравится ваша идея, что не разработчики вносят свой вклад в документацию для конечных пользователей.
Эта идея может мотивировать пользователей и тестировщиков вашего приложения легко вносить вклад в документацию.
Первое, что приходит мне в голову, это использование какого-то вики-движка. Вы можете создать простую функцию в вашем приложении WinForm, которая запускает браузер и направляет его в вики. Вы можете использовать контекст, из которого он вызывается, для создания URL; например http://dev-wiki.mycompany.com/LoginForm?action=edit, Здесь имя формы ("LoginForm") используется в URL-адресе вики-страницы.
Кроме того, вы можете просто использовать встроенный элемент управления веб-браузера для WinForms для доступа к вики. Это будет выглядеть примерно так:
var url = GetWikiUrl(myForm);
browserControl.Navigate(url);
Это было бы очень легко встроить в ваше приложение.
В контролируемой (офисной) среде это было бы очень легко настроить. В вашей производственной среде это может быть немного сложнее, но все же выполнимо. Это может также использовать некоторые вклады конечных пользователей.
Для написания документации я использую sphinx. Это позволяет вам документировать в виде простого текста и имеет различные форматы вывода (CHM, HTML, PDF и т. Д.).
Некоторые из них (chm, html) могут использоваться в качестве контекстно-зависимых источников справки.
Несмотря на простоту, пользовательский интерфейс sphinx (текстовый редактор и файл make) может не подойти для нетехнических пользователей.
Я бы порекомендовал использовать Help+Manual для создания документации CHM. Это похоже на MS Word, и любой пользователь ПК может начать разработку документов после короткого обучения. Но этот инструмент не является бесплатным:(