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

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

2 голосов
/ 15 октября 2010

Я занимаюсь разработкой приложения WinForm на языке c # 4.0 и хотел бы, чтобы другие коллеги (не являющиеся разработчиками) внесли свой вклад в написание контекстно-зависимого файла помощи конечному пользователю.Сначала я подумал, что могу использовать «HTML Help Workshop» от Microsoft, но он выглядит устаревшим (Vista и Windows 7 не поддерживаются).Затем я посмотрел на Sandcastle, но документации не хватает, и мне интересно, подходит ли это для нетехнических пользователей для написания документации для конечных пользователей.Так что я читал о RoboHelp, но это дорогой для меня путь.Я теряюсь во всей информации, которая доступна о файлах помощи.Может ли кто-нибудь помочь дать некоторые рекомендации или информацию о том, какие инструменты использовать и какой выходной формат я должен выбрать (все еще chm или другой).

Ответы [ 3 ]

1 голос
/ 15 октября 2010

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

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

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

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

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

Это будет очень легко внедрить в ваше приложение.

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

0 голосов
/ 24 февраля 2012

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

0 голосов
/ 15 октября 2010

Для написания документации я использую sphinx . Он позволяет вам документировать в виде простого текста и имеет различные выходные форматы (chm, html, pdf и т. Д.).

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

Несмотря на простоту, пользовательский интерфейс sphinx (текстовый редактор и файл make) может не подойти для нетехнических пользователей.

...