Task: Ustanovit konvence vývoje

Dohodnout konvence psaní kódu a dokumentace.

Purpose

Účelem je, aby kód a dokumentace projektu působili vizuálně konzistentně a byly tak srozumitelnější a čitelnější pro jakoukoli zainteresovanou stranu mimo vývojový tým projektu.

Relationships

Categories	Vhodné úkoly
Roles	Primary Performer: Vývojový tým	Additional Performers: Kontaktní osoba Technický pracovník
Inputs	Mandatory: Vývojové prostředky	Optional: Informace o produkčním prostředí Původní verze systému
Outputs	Vývojářské konvence
Process Usage	Proces vývoje softwaru v ASWI > Initiation > Připravit se na vývoj > Ustanovit konvence vývoje Proces vývoje softwaru v ASWI > Elaboration > Připravit se na implementaci > Ustanovit konvence vývoje

Main Description

Tým by měl před zahájením vývoje ustanovit vnitřní konvence pro psaní kódu produktu a jeho dokumentace, aby tak zlepšil orientaci ve výsledných artefaktech, a to jak jeden pro druhého, tak pro zákazníka, uživatele, správce aplikace, popř.: další vývojový tým v další fázi rozšiřování produktu.

Konvence zahrnují:

řádkování a odsazování kódu,
pojmenování proměnných, procedur, metod, tříd, objektů, atd.,
komentování kódu,
hierarchii nadpisů v dokumentaci,
fonty, velikosti a zvýraznění textu v dokumentaci,
apod.

Key Considerations

používané vývojové prostředky (programovací jazyky, textové editory, IDE, apod.), jejich možnosti, produkční prostředí a jeho parametry

Alternatives

V případě, že se jedná o brown-field projekt, je vhodné, aby tým nastudoval a dodržoval konvence (především kódu a jeho komentování) v systému již používané.