DEV-004 recommended Technical Documentation
Key systems documented
Complex or critical systems (payments, auth, integrations) need dedicated documentation beyond architecture overview.
Question to ask
"Payments went wrong — where does a new dev start?"
Pass criteria
- ✓ Each critical system has dedicated docs
- ✓ Docs explain flow, not just code location
- ✓ External integrations documented
- ✓ Understandable without reading all code
Fail criteria
- ✗ Critical systems undocumented
- ✗ Stubs or outdated docs
- ✗ Only API reference, no conceptual docs
- ✗ Tribal knowledge required
Verification guide
Severity: Recommended
Complex or critical systems (payments, auth, integrations) need dedicated documentation beyond architecture overview.
Check automatically:
# Look for system-specific documentation
find . -maxdepth 4 -type f -name "*.md" 2>/dev/null | xargs grep -liE "payment|billing|auth|authentication|order|fulfillment|subscription" 2>/dev/null | grep -v node_modules | head -10
# Check docs folder structure
ls -la docs/ 2>/dev/null
# Look for ADRs (Architecture Decision Records)
find . -maxdepth 4 -type d -name "*adr*" -o -name "*decision*" 2>/dev/null | grep -v node_modules
# Search for "how X works" style docs
grep -riE "how .* works|implementation|flow|process" docs/ --include="*.md" 2>/dev/null | head -10
Ask user:
- "What are the most complex or critical systems?" (payments, auth, integrations)
- "Is each one documented for someone new?"
- "Where would a dev learn how payments/auth/[X] works?"
Pass criteria:
- Each critical system has dedicated documentation
- Docs explain the flow, not just code location
- External integrations documented (Stripe, Auth0, etc.)
- New dev could understand without reading all the code
Fail criteria:
- Critical systems undocumented ("read the code")
- Docs exist but are stubs or outdated
- Only API reference, no conceptual explanation
- Tribal knowledge required for key flows
Cross-reference with:
- DEV-003 (architecture overview should reference key systems)
- DOC-002 (complex systems documentation)
Evidence to capture:
- List of critical systems identified
- Documentation status per system (exists, partial, missing)
- Location of docs
- Last updated dates