В своем проекте я использую программу (скрипт) Asciidoc для формирования документации на основе единого источника информации.
Создаю текстовый документ со специальными метками и с помощью AsciiDoc, преобразую его в DocBook, а затем с помощью Apache FOP - в набор документов формата HTML,PDF,CHM.
Пример фрагмента исходного текста:
[[spellcheck]]
== Проверка орфографии
=== Автоматическая проверка орфографии
Для автоматической проверки орфографии используется модуль проверки из <<softOpenOffice,OpenOffice>>.
По результатам проверки Формируется ряд отчетов, например: "ОТЧЕТ ПО АВТОМАТИЧЕСКОЙ ПРОВЕРКЕ ОРФОГРАФИИ ИСХОДНЫХ ФАЙЛОВ", "ОТЧЕТ ПО АВТОМАТИЧЕСКОЙ ПРОВЕРКЕ ОРФОГРАФИИ СЛОВАРЯ".
[NOTE]
Для использования автоматической проверки обязательно наличие установленного на компьютере <<softOpenOffice,OpenOffice>>.
[[spellcheck_orphoautosourcecodeany]]
==== Автоматическая проверка орфографии исходных файлов (любых)
Как выглядит:
На сайте: http://www.sourcelocalizer.ru/help/spellcheck.html
PDF: см. ссылку в углу экрана онлайн-справки или по ссылке http://www.sourcelocalizer.ru/help/sourcelocalizer.pdf
CHM: скачайте программу http://sourcelocalizer.ru/download :)
Создаю текстовый документ со специальными метками и с помощью AsciiDoc, преобразую его в DocBook, а затем с помощью Apache FOP - в набор документов формата HTML,PDF,CHM.
Пример фрагмента исходного текста:
[[spellcheck]]
== Проверка орфографии
=== Автоматическая проверка орфографии
Для автоматической проверки орфографии используется модуль проверки из <<softOpenOffice,OpenOffice>>.
По результатам проверки Формируется ряд отчетов, например: "ОТЧЕТ ПО АВТОМАТИЧЕСКОЙ ПРОВЕРКЕ ОРФОГРАФИИ ИСХОДНЫХ ФАЙЛОВ", "ОТЧЕТ ПО АВТОМАТИЧЕСКОЙ ПРОВЕРКЕ ОРФОГРАФИИ СЛОВАРЯ".
[NOTE]
Для использования автоматической проверки обязательно наличие установленного на компьютере <<softOpenOffice,OpenOffice>>.
[[spellcheck_orphoautosourcecodeany]]
==== Автоматическая проверка орфографии исходных файлов (любых)
Как выглядит:
На сайте: http://www.sourcelocalizer.ru/help/spellcheck.html
PDF: см. ссылку в углу экрана онлайн-справки или по ссылке http://www.sourcelocalizer.ru/help/sourcelocalizer.pdf
CHM: скачайте программу http://sourcelocalizer.ru/download :)
AsciiDoc очень удобен и прост в использовании, так как справка генерируется из системы контроля версий (svn) на сервере сборки (CI Hudson) с помощью сборочной программы (NAnt), которая еще и правит (используя регулярное выражение добавления ссылок для всех html-файлов) HTML, чтобы добавить в онлайн версию ссылки на содержание и прочее (штатные средства AsciiDoc для таких ссылок не очень подошли, см. формируемую ссылку в справке в правом верхнем угле).