Inhaltsverzeichnis
Kontrolni Seznam Projektne Dokumentacije
Različica: 2.0
Obseg: Pričakovanja vsebine za README.md / PROJECT.md / SKILL.md.
README.md (Končni Uporabniki)
- [ ] Enostavčni opis produkta
- [ ] Navodila za namestitev (Windows/Linux)
- [ ] Konfiguracijske možnosti s privzetimi vrednostmi
- [ ] Preprosti primeri uporabe
- [ ] Sekcija za odpravljanje težav
- [ ] Povezave do pomoči/podpore
PROJECT.md (Razvijalci)
- [ ] Sklicuje se na WvdS Best Practices na vrhu
- [ ] Jasna razlaga „kaj“ in „zakaj“
- [ ] Navigacija do pod-dokumentov (če razdeljeno)
- [ ] Build navodila ki delujejo od začetka
- [ ] Vse odvisnosti z različicami navedene
- [ ] Licenca in copyright
SKILL.md (AI Asistenti)
- [ ] YAML frontmatter z imenom/opisom
- [ ] Pod 300 vrsticami (glavna datoteka)
- [ ] Navigacija do pod-dokumentov
- [ ] Konvencije poimenovanja
- [ ] Build ukazi
- [ ] Sekcija hitre reference
- [ ] AI bi moral biti sposoben ponovno zgraditi vse pakete od začetka
Različica: 2.0 (Split)
Avtor: Wolfgang van der Stille
Nazaj na Projektni Kontrolni Seznami | Kontrolni Seznami za Preglede
Zuletzt geändert: dne 08.01.2026 ob 01:50