====== Documentation Checklist ======

**Version:** 2.0\\
**Scope:** Documentation triad, separation-of-concerns, and comment policy.

===== Documentation Triad (Required) =====

Every project MUST have in ''doc/'':

^ File ^ Audience ^ Purpose ^
| ''README.md'' | End Users | Install, Configure, Run |
| ''PROJECT.md'' | Developers | Architecture, Behavior |
| ''SKILL.md'' | AI Assistants | Enable Reconstruction |

  * [ ] ''doc/README.md'' exists - installation, configuration, usage
  * [ ] ''doc/PROJECT.md'' exists - what & why, architecture overview
  * [ ] ''doc/SKILL.md'' exists - AI development guide (<300 lines)

===== Documentation Separation of Concerns =====

For large projects, split into sub-documents:

  * [ ] ''PROJECT-ARCHITECTURE.md'' - Technical architecture
  * [ ] ''PROJECT-PACKAGES.md'' - Package structure
  * [ ] ''PROJECT-DEVELOPMENT.md'' - Development guide
  * [ ] ''SKILL-PACKAGES.md'' - Package specifications
  * [ ] ''SKILL-PATTERNS.md'' - Code patterns
  * [ ] ''SKILL-*.md'' - Domain-specific guides

===== Code Comments =====

  * [ ] All comments in English
  * [ ] File/module header with purpose and copyright
  * [ ] Public API documented (language-appropriate style)
  * [ ] Comments explain WHY, not WHAT
  * [ ] No commented-out code in production

----

//Version: 2.0 (Split)//\\
//Author: Wolfgang van der Stille//

Back to [[start|Infrastructure Checklists]] | [[..:start|Review Checklists]]

~~DISCUSSION:off~~