/docs

Простым языком

Проект растёт, а документация устарела или её вообще нет. Напиши /docs — Claude изучит код и создаст понятное описание: что за проект, как устроен, как запустить, как задеплоить. Чтобы через полгода ты сам мог разобраться.

Документация не содержит код — только объяснения и ссылки на нужные файлы. Открыл — понял проект, не читая исходники.

Что делает

/docs генерирует и обновляет документацию проекта по стандарту Vibe Framework. Создаёт или обновляет 4 файла Project Knowledge, README.md, CLAUDE.md. Ключевой принцип: документация содержит только ссылки на код, не сам код. Открыл — понял проект без чтения исходников.

Синтаксис

# Обновить существующую документацию
/docs

# Генерация с нуля
/docs generate

# Аудит: найти устаревшее
/docs audit

# Обновить конкретный файл
/docs update architecture

Пошаговый процесс

1. Читает существующую документацию, CLAUDE.md, README.md
2. project.md: обзор, аудитория, проблема, ключевые фичи, scope (что не делает)
3. architecture.md: стек (почему именно этот), структура, зависимости, модель данных
4. patterns.md: проектные паттерны, git workflow, бизнес-правила
5. deployment.md: платформа, env vars, CI/CD, rollback, мониторинг
6. Удаляет блоки кода из документации — заменяет ссылками на файлы
7. Помечает устаревшую информацию, проверяет что файлы из доков существуют

Примеры использования

После завершения большой фичи

Закончили реализацию Q&A системы — архитектура изменилась. /docs update architecture обновляет только нужный файл, не переписывает всё.

/docs update architecture

# Claude обновит:
# - Новые коллекции: Questions, Answers
# - Новые API: /api/views, /api/feed
# - Обновлённую схему данных
# - Ссылки на новые файлы

# Не трогает: patterns.md, deployment.md

Аудит перед деплоем

Перед крупным деплоем — проверяете что документация актуальна. /docs audit находит устаревшие ссылки, несуществующие файлы, плейсхолдеры.

/docs audit

# Результат:
НАЙДЕНО 4 проблемы:

[Warn] architecture.md:45 — упоминает /api/analytics, эндпоинт удалён
[Warn] deployment.md:12 — порт 3001 устарел, сейчас 3000
[Info] patterns.md:78 — TODO без срока (добавить в бэклог)
[Info] project.md — нет секции "Ограничения scope"

Исправить? [да/нет]

Автоматизация

DECISIONS.md — журнал стратегических решений. Когда выбираете технологию или принимаете архитектурное решение — /docs предлагает записать контекст. Через полгода не нужно гадать "почему именно PostgreSQL, а не MongoDB".

# Формат DECISIONS.md (генерирует /docs):
## [2026-02-15] Выбор Lexical вместо Slate

**Контекст:** Нужен богатый редактор для UGC-контента
**Решение:** Lexical (Meta) — лучшая интеграция с Payload CMS
**Альтернативы:** Slate (сложный API), TipTap (платные фичи)
**Последствия:** Lexical API нестабилен между минорами

Документация без кода — это то, что можно читать через год и всё ещё понимать. Код устаревает, решения — нет.