Skip to main content
rule CX Codex

1-documentation — Claude Code rule for Markdown docs

The 1-documentation rule guides edits to project Markdown: it keeps decisions and useful commands while removing repetition and temporary records. It applies to selected files and folders.

MIT ★ 571 updated 2026-10-29

Install into Claude Code · Manually: put the files in place All methods and platforms ↓
.claude/rules/1-documentation.md
Open on GitHub

What 1-documentation does

The rule covers README files, architecture documents, guides, and memory files at its configured paths. It asks the agent to edit lasting Markdown files individually, explain a project’s purpose, usage, and limits, and describe architecture through components, boundaries, flows, and invariants.

Edits should retain contracts, decisions and their rationale, procedures, linked anchors, and generator markers. The rule calls for trimming repeated material, narrated history, temporary evidence, and measured figures; diagrams can show relationships. It explicitly says not to invent performance requirements. For Claude Code, place the file at .claude/rules/1-documentation.md; other platforms use their own paths.

What it helps with

  • trim a README while retaining its purpose and limits
  • describe system components, boundaries, and flows
  • remove repetition and temporary notes from project docs
  • keep verification commands and links to canonical sources

Example prompts for the agent

  • Revise README.md under the documentation rule; retain its purpose, usage examples, and limits.
  • Reshape ARCHITECTURE.md to explain the components, boundaries, flows, and invariants.
  • Edit docs/setup.md, keeping verification commands and linked anchors while removing temporary notes.

How to install 1-documentation

Manually: put the files in place

.claude/rules/1-documentation.md

The paths frontmatter field limits the files

Step by step, with commands for each platform: AGENTS.md vs CLAUDE.md: what they are and which one to use

Questions about 1-documentation

How do I install 1-documentation in Claude Code?

Add the rule file at .claude/rules/1-documentation.md.

What does 1-documentation do?

It guides edits to Markdown files at configured paths, preserving decisions, procedures, and commands while cutting repetition and temporary material.

Which files does the rule cover?

It targets README, ARCHITECTURE, GUIDELINES, and CONTRIBUTING files, plus documents under docs/ and memory files under aidd_docs/memory/.

Source text

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

Similar IDE rules

All IDE rules for Writing and docs →
markdown-documentation aj-geddes markdown-documentation — a skill that gives the agent a fixed set of Markdown rules for READMEs, wikis and docs pages. Useful when the model writes the text and it has to look consistent. CX Codex +1 1,300installs how-to-documentation-cursorrules-prompt-file PatrickJS how-to-documentation-cursorrules-prompt-file — a Cursor rule that makes the AI write step-by-step how-to guides for non-technical readers. It turns test scripts and API docs into user-friendly instructions with a fixed document structure. CX Codex +1 ★ 41,178repo stars documentation-and-adrs addyosmani The documentation-and-adrs Claude Code skill records architecture decisions and helps detect documentation that no longer matches the code. It applies during public API changes, feature releases, and documentation checks. CX Codex +1 80,700installs documentation-writer official github documentation-writer — a skill that turns the agent into a technical writer following the Diátaxis framework: tutorials, how-to guides, reference, and explanation. Proposes structure before writing. CX Codex +1 27,757installs code-documentation-analyzer Jeremy Longshore Auto-activating skill for auditing code documentation: API references, user guides, architecture docs. Triggers on phrases like "code documentation analyzer" or "code analyzer". CX Codex +1 1installs code-documentation-tutorial-engineer Seth Hobson code-documentation-tutorial-engineer turns project source code into step-by-step guides and onboarding materials. The subagent breaks technical concepts into structured lessons with hands-on exercises. CX Codex ★ 42,780repo stars

From the same set80

The whole set →
resolve-conflict resolve-conflict resolves deterministic Git conflicts during merge, rebase, or cherry-pick. Stops right after staging modified files. CX Codex +1 ★ 571repo stars 0-deps-wiring The 0-deps-wiring rule sets where application dependencies are composed and how the graph is reused. It fits TypeScript projects with command handlers and use cases. CX Codex +1 ★ 571repo stars 01-plan 01-plan turns a request, a ticket or a file into a phased implementation plan: gather the input, read the code, hand back a plan. CX Codex +1 ★ 571repo stars 05-improve 05-improve examines conversation logs, evaluates visible token usage, and suggests targeted refinements without touching your code. CX Codex +1 ★ 571repo stars 03-prd 03-prd turns a need, idea or brainstorm into a structured product requirements document: a draft from a template, saved only once you approve it. CX Codex +1 ★ 571repo stars 08-three-amigos 08-three-amigos evaluates epics and user stories through product, delivery, or quality perspectives, then reconciles three separate reports before backlog edits. CX Codex +1 ★ 571repo stars 10-learn 10-learn — a skill for Claude Code, Cursor, and other platforms that records decisions, conventions, lessons, and code review findings as durable project knowledge. CX Codex +1 ★ 571repo stars 10-task 10-task — a skill that takes one bounded backlog task through framing, review and a final save. Reach for it when a piece of delivery work needs writing down, linking, ordering or closing. CX Codex +1 ★ 571repo stars

Project sponsors

Companies that keep this analytics open