Inhaltsverzeichnis
Projekt-Dokumentation Checklist
Version: 2.0
Scope: Inhaltserwartungen für README.md / PROJECT.md / SKILL.md.
README.md (End Users)
- [ ] Ein-Satz Produktbeschreibung
- [ ] Installationsanweisungen (Windows/Linux)
- [ ] Konfigurationsoptionen mit Defaults
- [ ] Einfache Nutzungsbeispiele
- [ ] Troubleshooting-Sektion
- [ ] Hilfe/Support-Links
PROJECT.md (Developers)
- [ ] Referenziert WvdS Best Practices oben
- [ ] Klare „was“ und „warum“ Erklärung
- [ ] Navigation zu Sub-Dokumenten (falls aufgeteilt)
- [ ] Build-Anweisungen die from scratch funktionieren
- [ ] Alle Abhängigkeiten mit Versionen gelistet
- [ ] Lizenz und Copyright
SKILL.md (AI Assistants)
- [ ] YAML Frontmatter mit Name/Description
- [ ] Unter 300 Zeilen (Hauptdatei)
- [ ] Navigation zu Sub-Dokumenten
- [ ] Naming Conventions
- [ ] Build Commands
- [ ] Quick Reference Sektion
- [ ] AI sollte alle Packages from scratch rebuilden können
Version: 2.0 (Split)
Autor: Wolfgang van der Stille
Zurück zu Projekt Checklists | Review Checklists
Zuletzt geändert: den 29.01.2026 um 15:13