Добрый день.
Заказчик очень уж хочет техническую документацию по проекту. В его ожиданиях "оно" выглядит следующим образом: коммиты с ключами к jira, с детальным описанием кода, с комментариями разработчика, а так же время, потраченное на каждую задачу. При всём этом ему заждется держать этого монстра в виде одного большого pdf файла. Собственно, тут и ежу понятно, что команда от такого "щастья" начнёт разбегаться. Может быть у кого-либо есть примеры документации с описанием кода, способные более-менее удовлетворить вышеизложенным фантазиям, но остающиеся в рамках разумного приличия?
Посмотрите в сторону ГОСТ34. Уже есть наработанные стандарты. Не обязательно использовать всё из этого, но можно взять то, что действительно важно и интересно. www.clientprav.ru/standard/gost_34
Я не знаю, что у Вас за проект. Но как-то модерировал сайт, было очень много работы, cms Битрикс. Не скажу, что он косячно был написан, просто его запустили. Изначально тоже говорили, что надо бы на будущее написать документацию, так как той, что есть у битрикса клиенту было не понять. Столкнулся с тем, что реально надо было бы описывать каждую запятую, уговорил забыть эту идею.
Вообще для такой цели (именно документация по коду, если я правильно понял вопрос) существуют специальные утилиты, которые позволяют выцеплять документацию/комментарии (написанную разработчиками прямо в коде). Вы смотрели в сторону doxygen (www.doxygen.org)?
P.S. Непонятно только, зачем все это _хранить_ в pdf. PDF - это средство представления, а не формат хранения/обработки.
Простой
