DOC-001 recommended general

Feature documentation exists (human + AI readable)

Documentation exists covering major features, accessible to both humans and AI agents. In-repo docs preferred; external (Notion, GitBook, wiki) acceptable if accessible.

Question to ask

"Could a new hire understand your system without asking you?"

Pass criteria

  • Documentation exists covering major features
  • In-repo docs preferred; external acceptable if accessible
  • Docs structured for both humans and AI agents

Fail criteria

  • No feature documentation anywhere
  • Only setup instructions, no feature descriptions
  • External docs exist but AI agents cannot access them

Verification guide

Severity: Recommended

Check automatically:

  1. Look for in-repo documentation (preferred):
# Check for common doc locations
ls -la docs/ README.md CLAUDE.md AGENTS.md ARCHITECTURE.md 2>/dev/null

# Find markdown files
find . -maxdepth 2 -name "*.md" -type f | head -20
  1. Check for API docs:
# OpenAPI/Swagger
find . -name "openapi*.yaml" -o -name "openapi*.json" -o -name "swagger*"
  1. Check README for external doc links:
grep -iE "documentation|docs|wiki|notion|gitbook|confluence" README.md

Ask user:

  • Where is feature documentation located? (in-repo preferred, external acceptable)
  • If external: Notion, GitBook, Confluence, wiki?
  • Can AI agents access the external docs? (important for AI-readability)

Pass criteria:

  • Documentation exists covering major features
  • In-repo docs preferred; external acceptable if accessible
  • Docs are structured enough for both humans and AI agents to understand

Fail criteria:

  • No feature documentation anywhere
  • Only setup instructions, no feature descriptions
  • External docs exist but AI agents can't access them (auth-walled with no workaround)

Evidence to capture:

  • Documentation location(s) - in-repo vs external
  • List of documented features
  • AI accessibility (can Claude read it?)

Section

14. Documentation

Observability