====== Kontrolni Seznam Dokumentacije ======

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

===== Dokumentacijska Triada (Zahtevana) =====

Vsak projekt MORA imeti v ''doc/'':

^ Datoteka ^ Občinstvo ^ Namen ^
| ''README.md'' | Končni Uporabniki | Namesti, Konfiguriraj, Poženi |
| ''PROJECT.md'' | Razvijalci | Arhitektura, Vedenje |
| ''SKILL.md'' | AI Asistenti | Omogoči Rekonstrukcijo |

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

===== Ločitev Skrbi Dokumentacije =====

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

===== Komentarji Kode =====

  * [ ] 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 [[start|Kontrolni Seznami Infrastrukture]] | [[..:start|Kontrolni Seznami za Preglede]]

~~DISCUSSION:off~~