Какие инструменты Ваша команда использует для записи руководств пользователя? [закрытый]

Моя компания использует MediaWiki и TikiWiki для большей части документации. У нас также есть парень, который компилирует материал в MS Word и форматы PDF для печати/отправки клиентам. Я рекомендовал бы избегать TikiWiki как чумы. MediaWiki является большим, и потому что это действительно просто в использовании и потому что все знают, как использовать его - это - фактическая стандартная Wiki, и по достоинству так, по моему скромному мнению.

Для doument код я использую Doxigen. Я предпочитаю версию Linux, я имел, имеют проблемы с несколькими функциями в версии Windows

Мы имели большой успех с DocToHelp. Это работает отлично с основанной на Microsoft Word документацией, а также другими формами, и это даже получило некоторые большие функции интеграции для Visual Studio.

большая часть - как только у Вас есть базовая основа документа, импортированная в DocToHelp, можно выбрать любой из многих форматов экспорта быть им WinHelp, Справка HTML, Справка Java или хорошее и представить себе доступную для поиска Сетевую Справку.

Мы используем Word. Это помещается в наше управление версиями, таким образом, у нас есть история (существует папка документации, связанная с каждым проектом). Форматированием можно управлять с помощью шаблонов, все из которых мы теперь настроили, так внесение изменений легко сделать в рамках стандартов расположения. Файлы могут быть экспортированы в PDF. Можно опубликовать их как документы только для чтения для совместного использования с пользователями.

попробуйте Dikiwiki

Для "руководств", DocBook. Это - диалект SGML, разработанный для технической документации. http://www.docbook.org/ . Это не может соответствовать Вашей "легкой разметке" критерий, но это определенно производит хороший вывод в Латексе (может быть преобразован тогда в PDF), и хороший вывод HTML, если Вы готовите свою собственную таблицу стилей CSS для него. Текстовые файлы сохранены в управлении версиями. Все программы также пользуются библиотекой, которая комбинирует парсинг параметра командной строки с "-справка" вывод в выборе форматов (нормальная, страница справочника и DocBook). Для ссылки API, doxygen, конечно.

В моем текущем задании мы производим в большом количестве программное обеспечение единственного использования, таким образом, документация часто ставится боковая линия и сделана в Word.

В моем последнем задании, однако, команда документации казалась непрерывно напыщенной речи и рейву [приблизительно 110] безумным продуктом программного обеспечения ограничения "Вспышка" . Это позволяет Вам писать в одном формате и публиковать ко многому носителю, таким образом, Ваше руководство может также быть Вашей справкой онлайн или веб-сайтом, и т.д.

Для нашего API мы используем Doxygen, который является большим.

Мы используем Wiki. Я рекомендую MoinMoin, потому что

• очень простой установить (даже на Ноутбуке)
• очень простой скопировать (можно даже передать Wiki системе управления версиями для синхронизации его между, скажем, ноутбуками для офлайнового использования).
• хороший синтаксис
• легкий расшириться
• Легкий искать

Мы не используем что-то как Word потому что:

• Документация гниет слишком быстро
• , Поиск всех документов является болью
• , Соединение между информационными битами является болью
• Никакая разность между версиями
• Двоичный формат, который гадит ад из любого VCS
• Никакие глубокие закладки
• , Документы становятся слишком большими, и затем они становятся неуклюжими: Разделение (и никакой поиск больше) или ожидает возрасты для загрузки.

Вы не упоминаете язык/платформу, который Вы используете. Там существуют действительно хорошие инструменты документации, но некоторые из них характерны для того, в чем Вы разрабатываете. Мы - магазин C#, таким образом, мой ответ будет только относиться к Вам при использовании.NET.

Мы используем Замок из песка , который не только свободен, но и с открытым исходным кодом. В то время как люди, прежде всего, думают о нем как строго приложение, которое генерирует документацию от Документации XML, можно обеспечить собственное содержание в MAML. Это может предназначаться и для CHM и для развертывания веб-сайта, который удовлетворяет наши потребности. Существуют некоторые дополнительные инструменты, которые могут обеспечить вещи, такие как маркировка избранного и оценок темы к моему пониманию, но мы не начали использовать их на данный момент.

Это предоставляет нам и внутреннюю и внешнюю документацию. Так как мы также используем Сервер Основы Команды, мы используем созданный в Wiki на Проекте Команды в Sharepoint, но это более приспособлено к сотрудничеству проекта.

Редактирование: Фиксированная неработающая ссылка, и также требуемый, чтобы упомянуть, что существуют другие инструменты в сочетании с Замком из песка, что мы используем. Вещами такой как Разработчик Справочного файла Замка из песка и GhostDoc являются общие инструменты. Первое для редактирования проектов Замка из песка и MAML и второго для улучшения качества комментария в коде.

Мы используем справка и руководство для руководства и справочного файла. Нет никакого экспорта HTML, но это обеспечивает справку HTML, winhelp, PDF и еще некоторые форматы.

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

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

, Если Вы сохраняете файлы в текстовом формате в своем репозитории, отслеживание пересмотра довольно просто.

Для документации кода, я использую doxygen.

ЛАТЕКС

В течение некоторого времени мы использовали DocBook, но было очень трудно расшириться с более усовершенствованными, и необходимыми функциями (подсветка синтаксиса, разделяющая на несколько файлов, управление многоязычием и т.д.). Позже, мы решили записать нашу собственную систему с нуля и выпустить ее как открытый исходный код: текст ссылки . Это использует файлы простого текста и Скидку с цены как язык синтаксиса, и теперь у нас есть все, в чем мы нуждаемся. Недостаток - то, что в настоящее время нет, вероятно, никакого синтаксического анализатора Скидки с цены, который производит что-то еще, чем вывод HTML. На данный момент это достаточно, но мы думаем о реализации поддержки PDF довольно скоро.

, Кроме того, мы - maintaing MediaWiki как основанная на сообществе справка.