Единственный исходный инструмент документации
Математическое знание часто полезно для программиста, как навык графического дизайна, решающая загадку способность, трудовая этика и хост других навыков и черт. Очень немного программистов способны ко всему, к чему может возможно быть способным программист. Я не согласился бы ни с каким оператором формы, "Вы не настоящий программист, если Вы не можете { вставлять любимую способность к программированию здесь }".
, Но я опасался бы программиста, который не мог сделать Математики. Больше, чем того, кто не мог потянуть.
4 ответа
Тот, который удовлетворяет большинству ваших требований, которые я использовал ранее, это AsciiDoc .
AsciiDoc не является исходным форматом XML, вместо этого он выбирает для простого текстового формата. Он может выводить HTML и Docbook, которые можно преобразовать в PDF или другие форматы. Исходный текст почти достаточно хорош и для представления обычного текста.
Другой популярный вариант в том же духе - reStructuredText .
Я подумывал о распространении DocBook в качестве замены Word в нашей группе разработчиков. Доступен ряд наборов инструментов. Самым простым для инженеров, вероятно, является DocBook XSL , Apache FOP и либо Ant , либо Make . Вот как я делаю свой DocBook. Если вам действительно нравится LaTeX, то вы можете попробовать DBLaTeX для среды публикации DocBook в LaTeX.
Если вы не против выйти за пределы бесплатных сред, то XML Editor предлагает довольно хороший редактор WYSIWYG DocBook. Я не так часто его использовал, но он выглядит многообещающим.
Doxygen ] - довольно популярный генератор документации, который может выводить документы в различных форматах . Хотя его основная цель - создание документации, извлеченной из комментариев к источникам (с множества языков), его также можно использовать в качестве общего инструмента для написания руководств. Фактически, веб-сайт и руководство Doxygen созданы таким образом.
Sphinx - это инструмент, который добавляет в Docutils ряд функций, позволяя писать «умную и красивую документацию» в reStructuredText. Первоначально он был создан для выпуска новой документации Python, но сейчас используется во многих других проектах.