Техническая документация, как и что писать?

Question

[ttywizard]

Я разработчик в крупном проекте. Проект состоит из множества связанных между собой частей, работающих на разных технологиях. Мне была поставлена задача написать техническую документацию к проекту. У меня имеется опыта документирования API, однако документированием всего проекта я никогда не занимался. Не знаю, что следует, а что не следует описывать. С чего начать? Прошу поделиться опытом и подсказать качественную литературу / статьи на эту тему, если такие имеются. Читал несколько статей на хабре, однако они не дали ответов на мои вопросы.

Answer 1

[twoone]

Во первых существует множество регламентов предназначенных для различных видов ПО в различных странах. Во вторых описание должно включать текстовое описание (цели\проблемы\решения), uml\bpmn2 диаграммы описывающие архитектуру\дизайн\сценарии. В третьих создать техническое описание продукта намного сложнее создания самого продукта поскольку это тоже самое только на других языках и более детально. Это сопоставимо с книгой, порой на тысячи страниц.

Для создания используется просто огромная куча инструментария, каждый из которых вот так просто не освоишь, нужно много читать и запоминать.

И вообще это делается либо сразу (подобное присуще очень крутым аутсорсинговым компаниям для которых это уже не первый опыт, что означает наличие на руках большей части необходимых деклараций), либо на всем протяжении жизни продукта всей коммандой, поскольку один человек подобное просто не осилит.