LINUX.ORG.RU
Форум — Development  

В чем писать доки?


0

0

Ребят, посоветуйте в чем писать документацию к программе? На работе используется Word - не кошерно. Для своего проекта хотелось бы чего-то более подходящее. Попробовал OpenOffice - еще хуже чем Word. Может есть специальные тулы и форматы? Посоветуйте, а?

★★
← [СИ] Где расположены данные сокета?
[Qt]Нажать на PushButton →

latex, docbook и где-то тут на форуме пробегала система разметки специально для техдоков.

mydoom ★★★
()
Ответ на: комментарий от dmitry_vk

> Эх, если бы у латеха был нормальный экспорт в html

Если ключевое слово «нормальный», то это дело вкуса.

Раньше изредка пользовался latex2html, для моих целей хватало (да, иногда приходилось что-то редактировать... надо попробавать на свежих версиях).

oami ★★
()
Ответ на: комментарий от oami

Проверил. Глюки с кодировкой при запуске с параметрами по умолчанию. Мда. Лучше не стало.

oami ★★
()

Tex? Генерить документацию с помощью doxygen? Literate programming? Уточни хоть, что надо, что за документация.

Gvidon ★★★★
()

питонячьи доки на reStructuredText

true_admin ★★★★★
()

GTK-doc и не изобретай велосипедов.

MuZHiK-2 ★★★★
()
Ответ на: комментарий от Gvidon

Обычная программерская документация. Концепты, функциональный дизайн, детальный дизайн со всякими flow chart'ами, сиквенс диаграммами и прочими прелестями.

DiKeert ★★
() автор топика
Ответ на: комментарий от DiKeert

>Обычная программерская документация. Концепты, функциональный дизайн, детальный дизайн со всякими flow chart'ами, сиквенс диаграммами и прочими прелестями.

Doxygen? И все диаграммы он сам построит. Вообще это зависит от того, на чём пишешь. В perl, например, принято писать в Pod.

anonymous
()

plain text files

+ Emacs org-mode

anonymous
()
Ответ на: комментарий от dmitry_vk

> Эх, если бы у латеха был нормальный экспорт в html (или он есть, но я о нем не знаю?), то был бы почти идеал.

HeVeA http://hevea.inria.fr/

anonymous
()

Не обращай внимание на какулы мамонта, предложенные ITT. Используй sphinx. Там и диаграммы и внятный индекс и выглядит прилично, в отличие от.

baverman ★★★
()

Какая именно документация? Если по исходникам, то однозначно doxygen он и html и latex умеет.

irq ★
()

Gedit.

Если требуется насыщение текста, OpenOffice → PDF.

Jayrome ★★★★★
()
Ответ на: комментарий от baverman

Плюсую Sphinx!

Можно еще asciidoc попробовать если нужно, что то совсем простое.

fat_angel ★★★★★
()

docbook + syntex serna - замечательный редактор для docbook

ott ★★★★★
()
Ответ на: комментарий от Zodd

А что? Есть люди которые прекрасно всё документируют в блокнотик, без всяких свистелок перделок.

anonymous
()

Доки пишутся в ворде, равно как и докИксы. Техническая документация - внутренняя в вики формате, сопроводительная в ХТМЛ.

Jetty ★★★★★
()

Спасибо всем, буду пробовать, сравнивать, как выберу что-нибудь - отпишусь почему, как и в чем профит.

DiKeert ★★
() автор топика

html же. К java например есть javadoc

Dudraug ★★★★★
()
Ответ на: комментарий от irq

> Если по исходникам, то однозначно doxygen он и html и latex умеет.

doxygen много языков понимает, да...

Совершенно бесполезное за пределами C++ поделие.

anonymous
()
Вы не можете добавлять комментарии в эту тему. Тема перемещена в архив.
← [СИ] Где расположены данные сокета?
Development
[Qt]Нажать на PushButton →