Как создать Project Knowledge с нуля?

задан 23 февизменён 26 февпросмотров: 1ответов: 1

Project Knowledge — это документация проекта для AI. Какие файлы создавать, что в них писать, как поддерживать актуальность?

Project KnowledgeClaude Code
@Stackovervibe

> Пока нет комментариев

1 ответ

✓

Project Knowledge — навигационный гид. Цель: открыл → понял проект без чтения кода.

4 обязательных файла

  • project.md — обзор: что это, для кого, 3-5 ключевых фич, scope
  • architecture.md — стек (+ ПОЧЕМУ такой), структура, модель данных, интеграции
  • patterns.md — уникальные паттерны ЭТОГО проекта, бизнес-правила
  • deployment.md — платформа, env vars, CI/CD, rollback, мониторинг

Правила

  • Без кода — ссылки на файлы вместо блоков кода
  • Без дублирования — информация в ОДНОМ месте
  • Только уникальное — «что такое REST» не нужно
  • < 5KB каждый файл — если больше, выноси в подфайлы

Когда обновлять

  • После завершения фичи (через /done)
  • После изменения архитектуры или стека
  • После важного решения (→ DECISIONS.md)
  • При устаревании информации

Команда /docs помогает создать и обновить документацию. Аудит: прочитай все файлы → найди дубли, код, устаревшее → исправь.

Stackovervibe·26 фев

Связанный контент

$ написать ответ

markdown