Skip to content

Commit 6d01689

Browse files
committed
docs: remove migration plan and add documentation policy
- Remove MIGRATION_PLAN_OXLINT_OXFMT.md (migration complete) - Add comprehensive documentation policy to CLAUDE.md - Policy minimizes doc clutter and enforces maintenance protocol - Establishes allowed/forbidden documentation patterns
1 parent 405f168 commit 6d01689

File tree

2 files changed

+36
-441
lines changed

2 files changed

+36
-441
lines changed

CLAUDE.md

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,42 @@ This is a reference to shared Socket standards. See `../socket-registry/CLAUDE.m
3535
- Forbidden to create docs unless requested
3636
- Required to do exactly what was asked
3737

38+
## 📄 DOCUMENTATION POLICY
39+
40+
**Philosophy**: Minimize documentation clutter. Code should be self-documenting; docs should be intentional.
41+
42+
**Allowed documentation files**:
43+
44+
- `README.md` - Project overview, installation, basic usage only
45+
- `CLAUDE.md` - AI assistant instructions
46+
- `SECURITY.md` - Security policy (GitHub standard)
47+
- `CHANGELOG.md` - Version history (auto-generated preferred)
48+
- `docs/` - Concentrated API/usage documentation (10 files max, keep concise)
49+
- `.claude/` - Claude Code commands/skills (functional, not documentation)
50+
- `*/README.md` - Only for plugins/, scripts/, or complex subsystems requiring context
51+
52+
**Forbidden documentation**:
53+
54+
- ❌ Migration plans after migration completes
55+
- ❌ Planning documents after implementation
56+
- ❌ Redundant "getting started" guides
57+
- ❌ Docs duplicating what's in code comments
58+
- ❌ Tutorial content better suited for external blog posts
59+
- ❌ Architecture decision records (ADRs) unless explicitly requested
60+
61+
**Maintenance protocol**:
62+
63+
1. **After completing migrations**: DELETE planning documents (e.g., `MIGRATION_PLAN_*.md`)
64+
2. **After major refactors**: REMOVE implementation plans
65+
3. **Quarterly review**: Audit and remove stale documentation
66+
4. **Before adding docs**: Ask "Can this be a code comment instead?"
67+
68+
**Enforcement**:
69+
70+
- AI assistants MUST NOT create documentation files unless explicitly requested
71+
- Code reviewers should challenge new documentation files
72+
- Prefer inline code documentation (`@fileoverview`, JSDoc) over separate markdown files
73+
3874
## ROLE
3975

4076
Principal Software Engineer: production code, architecture, reliability, ownership.

0 commit comments

Comments
 (0)