Разработка технической документации и технические писатели Технические писатели и разработка технической документации технические писатели в Телеграм 

 obmen_soobsheniyami.png Чат для технических писателей 
 Зарегистрируйтесь
Страницы: 1
RSS
Система разработки документации BullDoc
 
Здравствуйте, уважаемые писатели.

Хочу предложить инструмент для написания документации.

Этот инструмент для средних и мелких проектов, связанных с разработкой ПО. Он не похож на инструменты уровня Enterprise. Однако в случаях, когда разработчики тесно работают с системой контроля версий SVN, может оказаться весьма полезным. Ориентирован в основном на тех, кто разрабатывает ПО для веб, но, возможно, будет полезен кому-то еще.

Каждая разработка, если она хоть немного поэтичней, чем печать hello world, требует документации. И как-то так получалось, что я начинал писать документацию и все время наталкивался на то, что мне это неудобно:

Документация в MS Word (Open Office) не имеет подсветки кода, держит все в одном длинном документе, его не положишь в систему контроля версий для отслеживания изменений. Такой документ невозможно без лишних трудностей сохранить в html-коде, который будет размещён на сайте.

Microsoft HTML Help Compiler (и большинство програм для построения справки в формате CHM или WinHelp) позволяет все хранить в тексте, но не имеет подсветки синтаксиса, документ нельзя собрать в связанные html-страницы для выкладывания на сайт без active-x компонента

Формат Docbook тоже близок к желаемому, но XSLT трансформации сложны, подсветка синтаксиса — хоть и решаемая, но проблема.

Программы, генерирующие документацию на основе комментариев в коде (JDoc, PHPDocumentator) дают на выходе рабочий инструмент, но никак не документацию для конечного юзера.

Чтобы обойти заявленные неудобства и была написана программа BullDoc.

BullDoc — это система для создания документации. Представляет собой комплекс на php, который можно использовать без веб-сервера через командную строку, или в виде сайта под управлением apache. Исходники документации хранятся в текстовых файлах и могут быть помещены в svn. Документация экспортируется в полностью статический html(один файл на одну страницу или один монолитный файл), для размещения на сайте и для скачивания. Имеется экспорт в файл справки chm.

http://www.bulldoc.ru
 
Т.е текст пишится с использованием форматирования тегами?
Хочу все знать!
Страницы: 1
Читают тему