1-documentation — правило для Claude Code: документация и установка
Правило 1-documentation задаёт требования к Markdown-документации: сохраняет важные решения и команды, убирает повторы и временные записи. Срабатывает для указанных файлов и каталогов.
MIT ★ 571 обновлён 2026-10-29
.claude/rules/1-documentation.mdЧто делает 1-documentation
Правило применяется к README, архитектурным документам, руководствам и файлам памяти по заданным путям. Оно просит редактировать долговечные Markdown-файлы по отдельности, оставлять назначение, использование и ограничения проекта, а архитектуру описывать через компоненты, границы, потоки и инварианты.
При правке нужно сохранить контракты, решения и их обоснования, процедуры, ссылки-якоря и маркеры генераторов. Правило также предлагает убирать историю, повторы, временные свидетельства и измеренные показатели, а связи показывать схемами. Не выдумывайте требования к производительности: правило прямо запрещает это. Для Claude Code файл размещают по пути .claude/rules/1-documentation.md; другие платформы используют собственные пути.
Какие задачи решает
- сократить README, сохранив назначение и ограничения
- описать компоненты, границы и потоки системы
- убрать повторы и временные сведения из документации
- сохранить команды проверки и ссылки на источники
Примеры запросов агенту
- Перепиши
README.mdпо правилу документации, сохрани назначение, примеры использования и ограничения. - Приведи
ARCHITECTURE.mdв порядок: опиши компоненты, границы, потоки и инварианты. - Отредактируй
docs/setup.md, сохрани команды проверки и ссылки-якоря, убери временные записи.
Как установить 1-documentation
Вручную: положить файлы
.claude/rules/1-documentation.mdПоле paths во frontmatter ограничивает файлы
AGENTS.md
Codex читает AGENTS.md: вставьте текст правила туда
Вручную: положить файлы
.cursor/rules/1-documentation.mdcВо frontmatter: description, globs, alwaysApply
Вручную: положить файлы
.github/instructions/1-documentation.instructions.mdПоле applyTo задаёт, к каким файлам применять
Вручную: положить файлы
.devin/rules/1-documentation.mdВручную: положить файлы
.clinerules/1-documentation.mdПо шагам, с командами для каждой платформы: AGENTS.md и CLAUDE.md: что это, кто читает и какой выбрать
Вопросы о 1-documentation
Как установить 1-documentation в Claude Code?
Добавьте файл правила по пути .claude/rules/1-documentation.md.
Что делает 1-documentation?
Помогает редактировать Markdown-документы по заданным путям: сохранять важные решения, процедуры и команды, удаляя повторы и временные сведения.
Какие файлы обрабатывает правило?
Оно охватывает README, ARCHITECTURE, GUIDELINES, CONTRIBUTING, документы в docs/ и файлы памяти в aidd_docs/memory/.
Исходный текст
1-documentation.md · MIT
--- paths: - "**/README.md" - "**/ARCHITECTURE.md" - "docs/**/*.md" - "**/aidd_docs/memory/**/*.md" - "**/GUIDELINES.md" - "**/CONTRIBUTING.md" --- # Concise documentation - Edit durable, authored Markdown individually; exclude history, generated content and fixtures. - Architecture: components, boundaries, flows, invariants. README: purpose, usage, limits. - Use descriptive, hierarchical headings; include only relevant facts, once per document. - Preserve contracts, decisions, rationale, limits, procedures, linked anchors and generator markers. Keep memory safeguards self-contained; never invent performance requirements. - Remove filler, repetition, narrated history, dates, counters, ticket/run IDs, snapshots, temporary evidence and measured timings, ratios or comparisons. - Prefer diagrams for relationships and tables for roles; keep necessary prose concise. Retain required versions, constants and useful examples. - State actions and verification commands; link canonical sources for supporting details. - Read back: check section scope, preserved information, commands and links.
© ai-driven-dev · MIT · ai-driven-dev/framework