Бессмертный код или Скрижаль синьора
Эта статья будет интересна программистам, которые уважают собственный труд.
После того, как задача пришла к разработчику, он анализирует её, добавляет свои 5 копеек, получает цельное представление и в дальнейшем опирается на него. Скрижаль – это инструмент для сохранения этого представления, это структурированный свод артефактов и знаний, это описание контекста и решений, помогающих лучше понимать код. Важны все артефакты и знания, влияющие на решения.
Вся информация помещается в отдельный документ. Скрижаль не заменяет комментарии в коде, а всесторонне дополняет их. Большинство артефактов должны иметь собственную уникальную метку, помещенную в комментариях к коду.
Структура документа
Контекст
- Входные требования, ограничения, правила
- Решения, определенные заказчиком
- Решения и выводы, полученные в результате анализа задачи
- Входные спецификации
Структуры, форматы, объекты и знания о них. - Прочие знания
- Долг
Что не реализовано или планируется переделать.
Код
- Общий план решения
Рекомендуется излагать план решения в текстовом виде. - Выходные спецификации
Структуры, форматы, объекты и знания о них (трактовки, нюансы применения). - Промежуточные спецификации, использованные в коде
Структуры, форматы, объекты и знания о них. - Прочие знания
- Долг
Что не реализовано или планируется переделать.
Прочие моменты
В случае необходимости используете декомпозицию артефактов.
Разделы структуры не являются обязательными и используются только при необходимости.
Рекомендуется использовать для средних и сложных решений.