Markdown Documentation

Manage project documentation by verifying against actual codebase state. Emphasize verification over blind generation — analyze structure, files, and patterns before writing.

Portability

AGENTS.md is the universal context file (works with Claude Code, Codex, Kilocode). If the project uses CLAUDE.md, treat it as a symlink to AGENTS.md or migrate content into AGENTS.md and create the symlink:

# If CLAUDE.md exists and AGENTS.md doesn't
mv CLAUDE.md AGENTS.md && ln -sf AGENTS.md CLAUDE.md

When this skill references "context files", it means AGENTS.md (and CLAUDE.md if present as symlink).

Workflows

Update Context Files

Verify and fix AGENTS.md against the actual codebase. See update-agents.md for the full verification workflow.

Read existing AGENTS.md, extract verifiable claims (paths, commands, structure, tooling)
Verify each claim against codebase (ls, cat package.json, cat pyproject.toml, etc.)
Fix discrepancies: outdated paths, wrong commands, missing sections, stale structure
Discover undocumented patterns (scripts, build tools, test frameworks not yet documented)
Report changes

Update README

Generate or refresh README.md from project metadata and structure. See update-readme.md for section templates and language-specific patterns.

Detect language/stack from config files (package.json, pyproject.toml, composer.json)
Extract metadata: name, version, description, license, scripts
If README exists and --preserve: keep custom sections (About, Features), regenerate standard sections (Install, Usage)
Generate sections appropriate to project type (library vs application)
Report changes

Update CONTRIBUTING

Update existing CONTRIBUTING.md only — never auto-create. See update-contributing.md.

When updating, detect project conventions automatically:

Package manager from lock files (package-lock.json → npm, yarn.lock → yarn, pnpm-lock.yaml → pnpm, bun.lockb → bun)
Branch conventions from git history (feature/, fix/, chore/ prefixes)
Test commands from package.json scripts or pyproject.toml

Update DOCS

If DOCS.md exists, treat it as API-level documentation (endpoints, function signatures, type definitions). Verify against actual code the same way as AGENTS.md. Never auto-create DOCS.md — only update existing.

Initialize Context

Create AGENTS.md from scratch for projects without documentation. See init-agents.md.

Analyze project: language, framework, structure, build/test tools
Generate terse, expert-to-expert context sections
Write AGENTS.md, create CLAUDE.md symlink

Arguments

All workflows support:

--dry-run: preview changes without writing
--preserve: keep existing structure, fix inaccuracies only
--minimal: quick pass, high-level structure only
--thorough: deep analysis of all files

Backup Handling

Before overwriting, back up existing files:

cp AGENTS.md AGENTS.md.backup
cp README.md README.md.backup

Never delete backups automatically.

Writing Style

Terse: omit needless words, lead with the answer
Imperative: "Build the project" not "The project is built"
Expert-to-expert: skip basic explanations, assume competence
Scannable: headings, lists, code blocks
Accurate: verify every command and path against codebase
Sentence case headings, no emoji headers
Actionable headings: "Set SAML before adding users" not "SAML configuration timing"
Collapse depth with <details> blocks instead of deleting it (blank line after <summary> required for GitHub rendering)

README Anti-Patterns

Flag during Update README workflows:

Framework-first lead (explaining the tech stack before the problem it solves)
Jargon before definition (using project-specific terms without introduction)
Theory before try (architecture explanation before a working example)
Claims without evidence ("blazingly fast" with no benchmarks)

Report Format

After every operation, display a summary:

✓ Updated AGENTS.md
  - Fixed build command
  - Added new directory to structure

✓ Updated README.md
  - Added installation section
  - Updated badges

⊘ CONTRIBUTING.md not found (skipped)

md-docs