Kontrolni Seznam Dokumentacije

Različica: 2.0
Obseg: Dokumentacijska triada, ločitev skrbi in politika komentarjev.

Vsak projekt MORA imeti v doc/:

• [ ] doc/README.md obstaja - namestitev, konfiguracija, uporaba
• [ ] doc/PROJECT.md obstaja - kaj & zakaj, pregled arhitekture
• [ ] doc/SKILL.md obstaja - AI razvojni vodič (<300 vrstic)

Za velike projekte, razdeli v pod-dokumente:

• [ ] PROJECT-ARCHITECTURE.md - Tehnična arhitektura
• [ ] PROJECT-PACKAGES.md - Struktura paketov
• [ ] PROJECT-DEVELOPMENT.md - Razvojni vodič
• [ ] SKILL-PACKAGES.md - Specifikacije paketov
• [ ] SKILL-PATTERNS.md - Vzorci kode
• [ ] SKILL-*.md - Domensko-specifični vodičii

• [ ] Vsi komentarji v angleščini
• [ ] Datoteka/modul glava z namenom in copyrightom
• [ ] Javni API dokumentiran (jezikovno ustrezen stil)
• [ ] Komentarji razlagajo ZAKAJ, ne KAJ
• [ ] Brez izkomentirane kode v produkciji

Različica: 2.0 (Split)
Avtor: Wolfgang van der Stille

Nazaj na Kontrolni Seznami Infrastrukture | Kontrolni Seznami za Preglede