1.2 KiB
1.2 KiB
BORG - Yfirlit yfir skjölun
Þetta skjal veitir yfirlit yfir öll skjölunarskrár í BORG verkefninu.
Efnisyfirlit
Tæknileg skjölun
Leiðbeiningar fyrir skjölun
Þegar bætt er við nýrri skjölun í verkefnið:
- Setjið tæknilega skjölun í viðeigandi undirmöppu undir
Kerfishluti/* - Notið Markdown (.md) snið fyrir allar skjölunarskrár
- Notið skýrar fyrirsagnir og kafla
- Haldið skjölun uppfærðri með kóðabreytingum
- Skjalsetjið allar API breytingar, nýja eiginleika eða breytingar sem hafa áhrif á bakenda og framenda
Bæta við nýrri skjölun
Til að bæta við nýrri skjölun:
- Búið til nýja .md skrá í viðeigandi möppu
- Uppfærið þetta yfirlitsskjal með nýju skjöluninni
- Fylgið núverandi stíl og sniði skjölunar
- Bætið við viðeigandi tæknilegum upplýsingum og dæmum þar sem við á
Viðhald skjölunar
- Farið yfir og uppfærið skjölun reglulega
- Tryggið að skjölun endurspegli núverandi útfærslu
- Fjarlægið úreltar upplýsingar
- Bætið við nýjum köflum eftir því sem verkefnið þróast