Inhaltsverzeichnis

Checklist Documentazione

Checklist Documentazione

Versione: 2.0
Ambito: Triade documentazione, separazione responsabilita e policy commenti.

Triade Documentazione (Obbligatorio)

Ogni progetto DEVE avere in doc/:

File	Pubblico	Scopo
`README.md`	Utenti finali	Installazione, configurazione, esecuzione
`PROJECT.md`	Sviluppatori	Architettura, comportamento
`SKILL.md`	Assistenti AI	Abilitare ricostruzione

[ ] doc/README.md esiste - Installazione, configurazione, utilizzo
[ ] doc/PROJECT.md esiste - Cosa & perche, panoramica architettura
[ ] doc/SKILL.md esiste - Guida sviluppo AI (<300 righe)

Separazione Responsabilita Documentazione

Per progetti grandi dividere in sotto-documenti:

[ ] PROJECT-ARCHITECTURE.md - Architettura tecnica
[ ] PROJECT-PACKAGES.md - Struttura pacchetti
[ ] PROJECT-DEVELOPMENT.md - Guida sviluppo
[ ] SKILL-PACKAGES.md - Specifiche pacchetti
[ ] SKILL-PATTERNS.md - Pattern codice
[ ] SKILL-*.md - Guide specifiche dominio

Commenti nel Codice

[ ] Tutti i commenti in inglese
[ ] Header file/modulo con scopo e copyright
[ ] API pubblica documentata (stile appropriato al linguaggio)
[ ] Commenti spiegano PERCHE, non COSA
[ ] Nessun codice commentato in produzione

Versione: 2.0 (Split)
Autore: Wolfgang van der Stille

Torna a Checklist Infrastruttura | Checklist di Revisione