DKIP-GroupProjectPython

Правила оформления документации (doc-guidelines)

1. Основные форматы

• .md — основной формат.
• .pdf — отчёты и презентации (при необходимости).
• .yaml — OpenAPI-спецификация.

2. Обязательные документы

В project/documents должны быть:

• TZ.md — техническое задание.
• roadmap.md — дорожная карта.
• requirements/*.md — требования и сценарии.
• architecture/* — C4, ER, domain model, OpenAPI, ADR.
• testing/* — план, кейсы, Postman-коллекция.
• ui/* — UI kit, прототипы.
• devops/* — Docker, CI, мониторинг, деплой, бэкапы.

3. Требования к Markdown

• Заголовки: #, ##, ###.
• Списки: - или 1..
• Код: блоки lang.

4. README

Корневой README.md должен содержать:

• описание проекта;
• структуру репозитория;
• инструкции запуска;
• примеры запросов.