Sie befinden sich hier: start » hr » Interna dokumentacija » (!) Kontrolne Liste za Pregled » Kontrolne Liste Infrastrukture » Kontrolna Lista Dokumentacije

Inhaltsverzeichnis

Kontrolna Lista Dokumentacije

Verzija: 2.0
Opseg: Trijada dokumentacije, razdvajanje odgovornosti i politika komentara.

Trijada Dokumentacije (Obvezno)

Svaki projekt MORA imati u doc/:

Datoteka Publika Svrha
README.md Krajnji korisnici Instalacija, konfiguracija, pokretanje
PROJECT.md Razvojni programeri Arhitektura, ponašanje
SKILL.md AI asistenti Omogućiti rekonstrukciju
  • [ ] doc/README.md postoji - Instalacija, konfiguracija, korištenje
  • [ ] doc/PROJECT.md postoji - Što & zašto, pregled arhitekture
  • [ ] doc/SKILL.md postoji - AI vodič za razvoj (<300 redaka)

Razdvajanje Odgovornosti Dokumentacije

Za velike projekte podijeliti u pod-dokumente:

  • [ ] PROJECT-ARCHITECTURE.md - Tehnička arhitektura
  • [ ] PROJECT-PACKAGES.md - Struktura paketa
  • [ ] PROJECT-DEVELOPMENT.md - Vodič za razvoj
  • [ ] SKILL-PACKAGES.md - Specifikacije paketa
  • [ ] SKILL-PATTERNS.md - Uzorci koda
  • [ ] SKILL-*.md - Vodiči specifični za domenu

Komentari u Kodu

  • [ ] Svi komentari na engleskom
  • [ ] Header datoteke/modula sa svrhom i copyrightom
  • [ ] Javni API dokumentiran (stil primjeren jeziku)
  • [ ] Komentari objašnjavaju ZAŠTO, ne ŠTO
  • [ ] Nema zakomentiranog koda u produkciji

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

Natrag na Kontrolne Liste Infrastrukture | Kontrolne Liste za Pregled

Zuletzt geändert: 29.01.2026. u 20:54

Seiten-Werkzeuge