# BORG - Yfirlit yfir skjölun

Þetta skjal veitir yfirlit yfir öll skjölunarskrár í BORG verkefninu.

## Efnisyfirlit

### Tæknileg skjölun
- [Podcast Upptökur - Notkunarleiðbeiningar](Studio/Podcasts/USER.md)
- [Podcast Upptökur - Tæknilegt yfirlit](Studio/Podcasts/TECHNICAL.md)

## Leiðbeiningar fyrir skjölun

Þegar bætt er við nýrri skjölun í verkefnið:

1. Setjið tæknilega skjölun í viðeigandi undirmöppu undir `Kerfishluti/*`
2. Notið Markdown (.md) snið fyrir allar skjölunarskrár
3. Notið skýrar fyrirsagnir og kafla
4. Haldið skjölun uppfærðri með kóðabreytingum
5. 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:

1. Búið til nýja .md skrá í viðeigandi möppu
2. Uppfærið þetta yfirlitsskjal með nýju skjöluninni
3. Fylgið núverandi stíl og sniði skjölunar
4. 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