metaclass: (Default)
metaclass ([personal profile] metaclass) wrote2007-08-31 02:35 pm

Написание документации.

Хочу осознать Docbook для писания документаци, но что-то постоянно спотыкаюсь на немелком размере документации на него самого, причем как-то странно организованной - не понимаю с какой стороны начать изучение.

Для написания xml куча тулсов, в том числе и прямо поддерживающих docbook типа XMLSpy, но и то в них какой-то бред - то нужно FOP доставить для генерации PDF, то русского не понимает для PDF, то xml-entities типа   xsl-конвертор заменяет на &#160. И при этом стиль для конвертации надо руками указывать - т.е. уже знать, что docbook это набор стилей. Ни разу не самоочевидно.
Есть набор консольных утилит для компиляции docbook во что попало - но и они примерно так же нещадно бредят, страшно зависят от пути куда их поставили.
Половина утилит требует Java неясных версий.
И главное - все это не собрано в единообразном виде на одной странице - стили на sourceforge, утилиты для обработки xml по инету разбросаны, книжка про docbook отдельно лежит, еще и в нескольких версиях - сразу и не поймешь, к какой версии что относится. Коммерческие утилиты с собой тащат свою версию стилей.

Как это называется? Высокий порог вхождения, крутая кривая обучения?

[identity profile] zelanton.livejournal.com 2007-08-31 12:05 pm (UTC)(link)
Попробуйте Doc2Help - Генерирует на основе dос файлов CHM-мы, PDF-ы и кучу других форматов.

Сложно разобраться, но потом поток написания документации на её функционале работает отлично.

[identity profile] metaclass.livejournal.com 2007-08-31 12:07 pm (UTC)(link)
Нашел доки на русском
дока
ее исходник в docbook
Ржачь в том, что в исходнике оно читабельнее. А после того как я его конвертировал в один html файл стало еще читабельнее. Зачем же психи раскладывают по отдельным файлам?

[identity profile] beskov.livejournal.com 2007-08-31 12:48 pm (UTC)(link)
Можно запросить у [livejournal.com profile] ru_techwriters и в сюда, если прорвётесь

[identity profile] fantaseour.livejournal.com 2008-09-29 07:33 pm (UTC)(link)
если Вам еще актуален выбор инструмента для документации, посмотрите на мой скрипт

www.bulldoc.ru

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