Документирование проекта
Зачем нужна документация?
Процесс создания документации позволяет лучше разобраться в деталях реализуемого проекта.
Документация должна существовать для того, чтобы давать ответы на интересующие вопросы.
Документация не может объективно отобразить на каком этапе разработки находится проект. Эта задача возлагается на соответствующую систему (todo).
Документация должна освободить меня от необходимости постоянно хранить в голове всю возможную информацию по проекту.
Зачем мне документация?
В каком виде должна быть представлена документация и зачем она нужна? Сначала определимся с целью, иначе все описания какой должна она должна быть становятся бессмысленными, т.к. не приближают меня к цели. Целью документации является описание системы для её дальнейшего изучения другими пользователями. В процессе разработки документация должна помогать видеть на каком этапе я остановился и что ещё нужно сделать.
Существуют определенные стандарты на оформление документации, которые описывают структуры документа и предполагаемое содержание. Мой подход немного отличается, т.к. я хочу превратить процесс разработки документации в процесс разработки, когда куски кода генерируются автоматически исходя из документации.
Руководством к действию является тикет с заданием, пока задание не описывает, что необходимо сделать нелизя приступать к работе. Наличие тикетов позволяет отследить какие изменения были сделаны над проектом. На сколько детально должен быть описан тикет и как это сделать если часть информации будет доступна только в процессе выполнения? Перед тем как создать новый тикет ситуация должна изучаться и на основании имеющихся данных формулируется задача, если в процессе выполнения появляются трудности, то проводится дополнительное изучение и формируется новый зависимый тикет.
