Skip to main content
reopt Handbook
reopt Handbook
Agentic Documentation

Paradigm Shift

Why Documentation Must ChangeAI-readable Design PrinciplesAI-assisted Writing Process

Practice by Document Type

Project Rule DocumentsFrom Docs to Skills, Plugins, and MCPAgent Documentation SecurityAPI Docs and SpecsREADME and OnboardingArchitecture Decision RecordsRunbooks and OperationsUser Guides and TutorialsKnowledge Bases and Internal Wikis

Operations

Maintenance StrategyTeam Documentation Culture

Appendix

TemplatesVerification ReportUpdates
Handbook›에이전틱 시대의 문서화 혁신›Maintenance Strategy
한국어English

Maintenance Strategy

Keep docs, instructions, Skills, Plugins, MCP Resources, and validation loops from drifting.

Key takeaways

  • Agentic docs decay across many surfaces (README, API docs, AGENTS.md, CLAUDE.md, path rules, Skills, Plugins, MCP Resources, eval sets), each with its own drift signal and check.
  • Add a CI job that warns when src/app code changes without a matching docs or agent-instruction update.
  • Define a freshness policy with warn/critical thresholds (for example 90 and 180 days) and a list of files requiring review, while excluding history like ADRs and CHANGELOG.
  • Prioritize fixes by impact: P0 when an agent reads the wrong rule every task, down to P3 for rarely read internal docs.
  • Remove stale rules instead of only adding new ones, since rule accumulation bloats startup context.

Agentic documentation decays in more places than ordinary docs. You must maintain README files, API docs, AGENTS.md, CLAUDE.md, path rules, Skills, Plugins, MCP Resources, and eval sets.

What Drifts

SurfaceDriftCheck
README/docsbroken links, stale commandslink and command checks
AGENTS.mdwrong validation commandpackage script comparison
CLAUDE.mdduplicate or conflicting rulesimport and length review
.claude/rules/glob mismatchpath matching test
Skillsoutdated proceduresample smoke test
Pluginsinstalled version differsmanifest/version check
MCP Resourcesstale source datagenerated_at, source URL
MCP Toolsmissing side-effect docsschema and approval review

CI Check

name: Docs Sync Check
on:
  pull_request:
    paths:
      - 'src/**'
      - 'app/**'
      - 'docs/**'
      - 'AGENTS.md'
      - 'CLAUDE.md'
      - '.claude/**'
      - '.agents/**'

jobs:
  check-docs:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - name: Check docs need update
        run: |
          SRC_CHANGED=$(git diff --name-only origin/main...HEAD | grep -E '^(src|app)/' || true)
          DOCS_CHANGED=$(git diff --name-only origin/main...HEAD | grep -E '^(docs/|AGENTS.md|CLAUDE.md|\.claude/|\.agents/)' || true)
          if [ -n "$SRC_CHANGED" ] && [ -z "$DOCS_CHANGED" ]; then
            echo "::warning::Code changed without docs or agent instruction update."
          fi

Agent Smoke Tests

List the active project instructions and summarize the validation commands.
Do not modify files.
Use the release-check Skill for the current diff.
List risks and validation commands without editing files.

Freshness Policy

freshness:
  warn_after_days: 90
  critical_after_days: 180
  review_required:
    - AGENTS.md
    - CLAUDE.md
    - .claude/rules/**
    - .agents/skills/**
    - .codex-plugin/plugin.json
    - docs/api/**
  exclude:
    - docs/adr/**
    - CHANGELOG.md

Priority

PriorityCriteriaAction
P0agent reads wrong rule every taskfix now
P1API or runbook conflicts with behaviorfix before release
P2Skill/Plugin is stale but avoidableschedule
P3rarely read internal docarchive or delete

Checklist

ItemCheck
each surface has an owner[ ]
code changes trigger doc checks[ ]
commands in docs match actual scripts[ ]
Skills and Plugins have smoke tests[ ]
MCP Resources have source and freshness[ ]
stale rules are removed, not just added to[ ]

Related docs

From Docs to Skills, Plugins, and MCP

Split rules, workflows, distribution units, and external context into the right agent surface.

Knowledge Bases and Internal Wikis

Design KBs for RAG, MCP Resources, freshness, and citation-first answers.

Operations: Entropy and Garbage Collection

Harness Engineering · Explain how harnesses decay and how teams keep docs, workflows, permissions, hooks, and runtime surfaces current.

Repo-Readable Systems

Harness Engineering · Use AGENTS.md, docs, observability, executable SSOT, MCP, skills, hooks, and plugins as one work environment.

MCP Enterprise Data

Vercel Enterprise AI Platform · Connect enterprise systems to AI agents through MCP tools, resources, and prompts.

Knowledge Bases and Internal Wikis

Design KBs for RAG, MCP Resources, freshness, and citation-first answers.

Team Documentation Culture

Govern agent instructions, Skills, Plugins, MCP servers, ownership, and rollout.

On this page

What DriftsCI CheckAgent Smoke TestsFreshness PolicyPriorityChecklist