system/tools/project-docs/README.md

Project Docs — Генератор документации

Создаёт структуру документации для любого проекта.

Быстрый старт

# Инициализировать docs в текущей папке
project-docs init

# Создать для конкретного типа проекта
project-docs init --type drupal
project-docs init --type python
project-docs init --type solution

# С параметрами
project-docs init --name "Мой Проект" --type drupal --author "Team"

Типы проектов

Тип Описание Документы
default Базовый проект CLAUDE.md, PROJECT.md
drupal Drupal сайт/модуль + STACK.md, TESTING.md
python Python проект + API.md, TESTS.md
solution Бизнес-решение + CHECKLIST.md, REQUIREMENTS.md
api API сервис + ENDPOINTS.md, AUTH.md
library Библиотека + USAGE.md, CHANGELOG.md

Структура документации

project/
├── CLAUDE.md           ← Контекст для Claude (обязательно)
├── PROJECT.md          ← Описание проекта
├── docs/               ← Документация
│   ├── ARCHITECTURE.md ← Архитектура
│   ├── SETUP.md        ← Установка
│   └── ...             ← По типу проекта
└── management/         ← Управление
    ├── TODO.md         ← Задачи
    ├── CHANGELOG.md    ← История изменений
    └── STATUS.md       ← Текущий статус

Команды

project-docs init [--type TYPE] [--name NAME]   # Инициализация
project-docs add TEMPLATE                        # Добавить документ
project-docs list                                # Список шаблонов
project-docs validate                            # Проверить структуру

Файл конфигурации

После инициализации создаётся .project-docs.yml:

name: My Project
type: drupal
version: 1.0.0
created: 2025-12-21
docs:
  - CLAUDE.md
  - PROJECT.md
  - docs/ARCHITECTURE.md