|
0 Всего найдено: 1
monah_tuk
Сообщение
26/08/2010 01:24
Копия темы
0
О небходимости документации Рассуждения о необходимости документирования проектов: небольшая заметка, для тех, кто впечатлился, вот несколько инструментов, для подготовки оной: Writing Documentation – Part 1: POD: Writing Documentation, Part II: LaTeX with latex2html: Writing Documentation, Part III: DocBook/XML: Writing Documentation, Part IV: Texinfo: От себя отмечу, что POD оказался очень удобным для создания man-страниц. А так же добавлю про систему Doxygen, при помощи которой можно готовить документацию не только для исходного кода (хотя это тоже очень важно и провоцирует писать кометарии к коду). Недавно вот пришлось разбираться с картографическими программами под Linux, и повозиться с библиотекой GDAL (для работы с растровыми геоданными), так там страницы руководств формируются при помощи .dox файлов, так что за примерами можно сунуться туда. О примерах отвратительного документирования можно почитать у меня: В общем, надеюсь, на мысли навело, остальное – дело техники :) |
|
Выразить восторг, поругаться или предложить что-нибудь можно на форуме |
Для обсуждения этого сервиса так же есть темы на фрилансе по поиску , флудотопу ,и по удалённым сообщениям ,и по Актуальным/популярным темам , и по топу "кто кому больше наотвечал" |