Kontrolna Lista Dokumentacije Projekta

Verzija: 2.0
Opseg: Očekivani sadržaj za README.md / PROJECT.md / SKILL.md.

• [ ] Opis proizvoda u jednoj rečenici
• [ ] Upute za instalaciju (Windows/Linux)
• [ ] Opcije konfiguracije sa zadanim vrijednostima
• [ ] Jednostavni primjeri korištenja
• [ ] Sekcija za rješavanje problema
• [ ] Linkovi za pomoć/podršku

• [ ] Referenca na WvdS Best Practices na vrhu
• [ ] Jasno objašnjenje „što“ i „zašto“
• [ ] Navigacija do pod-dokumenata (ako je podijeljeno)
• [ ] Upute za build koje rade from scratch
• [ ] Sve ovisnosti navedene s verzijama
• [ ] Licenca i copyright

• [ ] YAML Frontmatter s Name/Description
• [ ] Ispod 300 redaka (glavna datoteka)
• [ ] Navigacija do pod-dokumenata
• [ ] Konvencije imenovanja
• [ ] Build naredbe
• [ ] Quick Reference sekcija
• [ ] AI treba moći rebuildati sve pakete from scratch

Verzija: 2.0 (Split)
Autor: Wolfgang van der Stille

Natrag na Kontrolne Liste Projekta | Kontrolne Liste za Pregled