Документация кода и Git
Программисту · в рубрике: 16.
- ADRОформляет архитектурное решение в формате ADR.
- OpenAPI-спецификацияГенерирует или обновляет OpenAPI/Swagger по коду.
- READMEПишет README: описание, установка, запуск, примеры, структура.
- Архитектурный документОписывает архитектуру проекта с диаграммами.
- Документация APIГенерирует документацию API с примерами запросов.
- Комментарии и docstringsДобавляет docstrings/JSDoc к публичным функциям.
- Коммиты по Conventional CommitsРазбивает изменения на атомарные коммиты с понятными сообщениями.
- Онбординг в кодовую базуОбъясняет новичку устройство проекта: где что лежит, как запустить.
- Описание PRПишет описание pull request: что, зачем, как проверить, риски.
- Разрешение конфликтовРазрешает merge-конфликты с сохранением обеих логик.
- Релиз-ноутыСобирает changelog и релиз-ноуты по коммитам.
- Чистка Git-историиПриводит ветки и историю в порядок: squash, rebase, удаление старых веток.
- Запись об архитектурном решении (ADR)Помогает выбрать между технологиями и оформить решение: варианты, плюсы и минусы, компромиссы и последствия.
- Коммит и pull request одним шагомЗа один проход добавляет изменения в индекс, коммитит, отправляет ветку и открывает черновой pull request на GitHub.
- Техническая документацияПишет README, документацию к API, ранбуки и архитектурные документы для нужной аудитории.
- Словарь терминов проектаПомогает выстроить доменную модель проекта: уточняет термины, ловит расхождения и ведёт словарь и записи о решениях.