← всі звіти · feedback_project_documentation_pipeline.md
name: Project documentation pipeline
description: Як нарощувати документацію по кожному проекту від ідеї до фіч. Стандарт Сергія.
type: feedback
originSessionId: ff491aab-005d-4454-ba7e-7018272512dc
Правило: Документація зростає разом з проектом
Кожен проект Deltamedical/особистий має проходити документаційний цикл:
Ідея → Brief → Технічне завдання / Тех-дизайн → Технічна документація → Фічі
- Ідея — фіксуємо коротко у wiki/{project}/index.md (що має робити проект, для кого, навіщо)
- Brief — обростає деталями: аудиторія, цінність, метрики успіху
- ТЗ / Тех-дизайн — як це має працювати: архітектура, стек, flow
- Технічна документація — деталі імплементації, endpoints, схеми даних
- Фічі — документація починає обростати фічами в міру реалізації
Why: у Deltamedical багато проектів на різних стадіях. Стратегія — повільно ростити всі, періодично робити ревю, доводити до MVP по одному. Без структури документації проекти губляться.
How to apply:
- При старті будь-якого нового проекту — створити
/srv/wiki/{project}/index.md зі стадією "Ідея" + brief
- Після кожної значної розмови з Сергієм — оновлювати відповідну wiki-сторінку (підніматись рівнем — ідея→brief→ТЗ)
- У Notion кожен проект має мати короткий опис + посилання на документацію
- Всі проекти (локальні + wiki + Notion) — тримати в синхроні через
agents_inventory.md
- Періодично (раз на ~тиждень) — робити scan Notion на нові проекти і синхронізувати з wiki