Checklist Documentazione Progetto

Versione: 2.0
Ambito: Contenuto atteso per README.md / PROJECT.md / SKILL.md.

README.md (Utenti Finali)

  • [ ] Descrizione prodotto in una frase
  • [ ] Istruzioni installazione (Windows/Linux)
  • [ ] Opzioni configurazione con valori predefiniti
  • [ ] Esempi d'uso semplici
  • [ ] Sezione risoluzione problemi
  • [ ] Link aiuto/supporto

PROJECT.md (Sviluppatori)

  • [ ] Riferimento alle WvdS Best Practices in alto
  • [ ] Spiegazione chiara „cosa“ e „perche“
  • [ ] Navigazione a sotto-documenti (se diviso)
  • [ ] Istruzioni build che funzionano da zero
  • [ ] Tutte le dipendenze elencate con versioni
  • [ ] Licenza e copyright

SKILL.md (Assistenti AI)

  • [ ] YAML Frontmatter con Name/Description
  • [ ] Sotto 300 righe (file principale)
  • [ ] Navigazione a sotto-documenti
  • [ ] Convenzioni di denominazione
  • [ ] Comandi build
  • [ ] Sezione Quick Reference
  • [ ] AI dovrebbe poter ricostruire tutti i pacchetti da zero

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

Torna a Checklist Progetto | Checklist di Revisione

Zuletzt geändert: il 29/01/2026 alle 21:06