project-knowledge
Создание и обновление документации проекта: project.md, architecture.md, patterns.md, deployment.md.
Описание
Простым языком
Возвращаешься к проекту через месяц — и тратишь полдня чтобы вспомнить как он устроен. Или объясняешь Claude контекст заново в каждой сессии. Этот скилл создаёт живую документацию, которую AI читает сам.
Один раз попроси Claude написать документацию по проекту — и в следующий раз он сразу поймёт что к чему. Как записная книжка, только умнее.
Что делает
Скилл project-knowledge создаёт и поддерживает папку docs/project-knowledge/ — живую документацию проекта для AI-агентов. Четыре файла: project.md, architecture.md, patterns.md, deployment.md.
Это навигационный гид для Claude: открыл документацию → понял проект без чтения кода. Обновляется после каждой фичи, не устаревает.
Когда использовать
- Начинаешь новый проект и хочешь с первого дня иметь хорошую документацию
- Проект вырос и Claude перестал понимать контекст с первого раза
- Возвращаешься к проекту через месяц-другой
- Хочешь передать проект другому разработчику (или AI-агенту)
- Провести аудит документации — что устарело, что дублируется
Как работает — пошагово
- Claude читает существующий код,
CLAUDE.md,package.json,docker-compose.yml - Составляет
project.md: что за проект, для кого, 3-5 ключевых фич, scope - Составляет
architecture.md: стек + ПОЧЕМУ, структура, зависимости, модель данных - Составляет
patterns.md: уникальные паттерны ЭТОГО проекта, git workflow - Составляет
deployment.md: платформа, env vars, CI/CD, rollback, мониторинг - Обновляет
CLAUDE.md— ссылки на документацию, ключевые правила
Промпты для Claude
/project-knowledge
Создай документацию для текущего проекта.
Прочитай все ключевые файлы и составь 4 документа.Обнови architecture.md — мы добавили Redis для кэширования
и переехали с REST на tRPC для фронтенд-бэкенд связи.Пример architecture.md
# Архитектура StackOverVibe
## Стек
- **Next.js 14** — App Router, SSR/SSG (выбрали за SEO)
- **Payload CMS** — headless CMS, PostgreSQL под капотом
- **TypeScript** — строгая типизация, 0 any
- **Tailwind CSS** — утилитарный CSS, дизайн-система
## Структура
src/
├── app/ # Next.js страницы (App Router)
├── components/ # React компоненты
├── collections/ # Payload CMS коллекции
├── lib/ # Бизнес-логика, утилиты
└── seed/ # Скрипты наполнения данными
## Ключевые решения
- Payload CMS вместо Strapi: лучший TypeScript-support
- App Router вместо Pages: layout.tsx, server componentsАвтоматизация
Добавь в CLAUDE.md правило обновлять документацию после каждой фичи:
## Workflow: после каждого блока
1. Обнови ПРОГРЕСС в CLAUDE.md
2. Если изменилась архитектура — обнови architecture.md
3. Если появились новые паттерны — обнови patterns.md
4. Коммит: "docs: обновить project-knowledge после [фича]"Частые вопросы
Документация устаревает — как поддерживать?
После каждой значимой фичи добавляй в промпт: "обнови architecture.md". Claude читает изменения в коде и актуализирует документ. Занимает 2-3 минуты.
Можно ли хранить код в документации?
Нет — это антипаттерн. Код устаревает и раздувает контекст. Вместо кода — ссылки на файлы: [auth.ts:45-67](src/auth/jwt.ts#L45).
> Пока нет комментариев
Связанный контент
Похожие инструменты
/docs
Генерация и обновление документации: Project Knowledge, CLAUDE.md, README.md, DECISIONS.md.
Открыть →/backlog
Управление бэклогом: просмотр, добавление задач, приоритизация через AI. Ничего не теряется.
Открыть →/status
Статус проекта: git (ветка, изменения), Docker (контейнеры), ошибки, прогресс по задачам.
Открыть →backlog-management
Управление бэклогом проекта: добавление задач, приоритизация, статусы, типы. Всё, что "потом" — в бэклог.
Открыть →