К основному содержанию
правило CX Codex

1-documentation — правило для Claude Code: документация и установка

Правило 1-documentation задаёт требования к Markdown-документации: сохраняет важные решения и команды, убирает повторы и временные записи. Срабатывает для указанных файлов и каталогов.

MIT ★ 571 обновлён 2026-10-29

Установить в Claude Code · Вручную: положить файлы Все способы и платформы ↓
.claude/rules/1-documentation.md
Открыть на GitHub

Что делает 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 и 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

Похожие правила IDE

Все правила IDE по теме «Тексты и документация» →
markdown-documentation aj-geddes Скилл markdown-documentation для Claude Code задаёт агенту правила оформления Markdown: README, вики, страницы документации. Приводит тексты, которые пишет модель, к единому виду. CX Codex +1 1 300установок how-to-documentation-cursorrules-prompt-file PatrickJS Правило how-to-documentation-cursorrules-prompt-file для Cursor превращает технические материалы в понятные пошаговые инструкции для обычных пользователей. Работает как персона-промпт: ИИ пишет how-to гайды по заданной структуре. CX Codex +1 ★ 41 178звёзд репо documentation-and-adrs addyosmani Скилл documentation-and-adrs для Claude Code фиксирует архитектурные решения и помогает находить устаревшую документацию. Подключается при изменении публичного API, выпуске функций и проверке соответствия документов коду. CX Codex +1 80 700установок documentation-writer официальный github Скилл documentation-writer для создания технической документации по фреймворку Diátaxis: туториалы, гайды, справки и объяснения. Предлагает структуру перед написанием. CX Codex +1 27 757установок code-documentation-analyzer Jeremy Longshore Автоактивируемый скилл для разбора документации кода: API-справочники, руководства пользователя, архитектурные описания. Включается по фразам вроде «code documentation analyzer» или «code analyzer». CX Codex +1 1установок code-documentation-tutorial-engineer Seth Hobson Субагент code-documentation-tutorial-engineer превращает исходный код в пошаговые обучающие материалы и руководства по онбордингу. Субагент раскладывает сложные концепции на понятные уроки с практическими упражнениями. CX Codex ★ 42 780звёзд репо

Из того же набора80

Весь набор →
resolve-conflict Скилл resolve-conflict помогает разобрать детерминированные конфликты при merge, rebase или cherry-pick. Останавливается сразу после индексации исправленных файлов. CX Codex +1 ★ 571звёзд репо 0-deps-wiring Правило 0-deps-wiring для Claude Code задаёт, где создавать зависимости приложения и как не собирать один граф повторно. Организует создание зависимостей для команд и сценариев использования в TypeScript-проекте. CX Codex +1 ★ 571звёзд репо 01-plan Скилл 01-plan превращает запрос, тикет или файл в план реализации по фазам: сначала сбор вводных, потом изучение кода, в конце готовый план. CX Codex +1 ★ 571звёзд репо 05-improve Скилл 05-improve анализирует историю диалога с агентом, оценивает видимый расход токенов и предлагает точечные улучшения без правок в коде. CX Codex +1 ★ 571звёзд репо 03-prd Скилл 03-prd превращает потребность, идею или брейншторм в структурированный PRD: черновик по шаблону, затем сохранение после вашего одобрения. CX Codex +1 ★ 571звёзд репо 08-three-amigos Скилл 08-three-amigos анализирует эпики и пользовательские истории через призму продукта, разработки или качества, а затем сводит три отчёта перед правками в бэклоге. CX Codex +1 ★ 571звёзд репо 10-learn Скилл 10-learn для Claude Code, Cursor и других платформ, который помогает записывать и формализовать решения, соглашения, уроки и находки из кода. CX Codex +1 ★ 571звёзд репо 10-task Скилл 10-task для Claude Code проводит ограниченную задачу бэклога через описание, проверку и запись. Оформляет, связывает, оценивает или закрывает задачи. CX Codex +1 ★ 571звёзд репо

Спонсоры проекта

Компании, которые помогают держать аналитику открытой