Fara beint í efni
MiðlungsForritun

Yfirferð og viðgerð skjölunar

Sannreynir hverja fullyrðingu í skjölun gegn raunverulegum kóða og merkir hana RÉTT, ÚRELT, RANGT eða DRAUGUR. Sannprófun fer gegn kóðanum, ekki gegn annarri skjölun — skjal sem staðfestir annað skjal sannar ekkert.

Fyrirmæli

Þú ert gæðaúttektaraðili á skjölun. Farðu yfir hverja markdown-skrá, hvert README og hverja skjölunarafurð í þessu verkefni. Sannreyndu hverja fullyrðingu gegn raunverulegum kóða og skilaðu heildarskýrslu.

FASI 1 — SKRÁNING SKJÖLUNAR
Finndu og teldu hverja skjölunarskrá:
- README.md (í rót og undirmöppum)
- Allar .md-skrár hvar sem er í verkefninu (heildartala)
- Skjölunarmöppur (docs/, doc/, wiki/, guides/)
- Stillingaskjölun: .env.example, athugasemdir í docker-compose, lýsingar á CI/CD-ferlum
- API-skjölun: OpenAPI/Swagger-lýsingar, uppflettirit
- Breytingaskrár, leiðbeiningar fyrir framlög, öryggisstefnur

Skilaðu skráningartöflu: | Flokkur | Fjöldi | Staðsetning |

FASI 2 — SANNPRÓFUN
Fyrir hverja lykilskrá skaltu sannreyna HVERJA staðreyndafullyrðingu gegn raunverulegum kóða. Settu niðurstöður fram svona:
| Fullyrðing | Staða | Sönnun |
þar sem staðan er: RÉTT, ÚRELT, RANGT eða DRAUGUR (vísar í eitthvað sem er ekki til).

Tilteknar athuganir:
- README og verkefnisskjöl: passa uppsetningarskipanirnar við package.json? Eru eiginleikarnir sem taldir eru upp raunverulega útfærðir? Er tæknistaflinn réttur í útgáfum?
- Umhverfisbreytur: grep-aðu að ÖLLUM lestri umhverfisbreyta í kóðanum (process.env, os.environ og fleira) og berðu saman við skjalfestar breytur. Listaðu hverja óskjalfesta breytu.
- Tilvísanir í skráaslóðir: eru skrárnar sem vísað er í raunverulega á þeim slóðum?
- Kóðadæmi: nota þau núverandi innflutning, API-undirskriftir og mynstur?
- Talnafullyrðingar (fjöldi prófa, fjöldi háðra pakka): staðfestu með því að keyra skipanirnar eða telja
- Slóðatöflur: berðu skjalfestar slóðir saman við raunverulegar slóðaskrár

FASI 3 — GATAGREINING
Finndu skjölun sem vantar, raðað eftir alvarleika:

KRÍTÍSKT (hindrar nýliða eða veldur rangri uppsetningu):
- Óskjalfestar umhverfisbreytur sem myndu fella keyrslu
- Röng breytuheiti sem myndu fella útgáfu
- Forsendur uppsetningar sem vantar

VIÐVÖRUN (veldur ruglingi en ekki bilun):
- Úreltar útgáfutölur eða prófatalningar
- Úreltar skráaslóðir
- Skjölun sem vantar fyrir stóra eiginleika

UPPLÝSING (gott að hafa):
- Kóðadæmi sem mætti bæta
- Uppbygging sem mætti skýra
- Þverkantar milli skjala sem vantar

FASI 4 — LAGFÆRINGARÁÆTLUN
Skilaðu töflu yfir lagfæringar í forgangsröð:
| # | Skrá | Vandi | Alvarleiki | Lagfæring | Vinna |

Aðgreindu skýrt: hvað er RANGT (verður að laga), hvað er ÚRELT (ætti að uppfæra) og hvað VANTAR (mætti bæta við).

TAKMARKANIR:
- Sannreyndu gegn kóðanum, ekki gegn annarri skjölun — skjal sem staðfestir annað skjal sannar ekkert
- Sérhver fullyrðing um að eitthvað sé rangt verður að bera sönnun úr kóðanum
- Ekki breyta skjölun í þessari yfirferð — skilaðu skýrslunni fyrst
- Skráðu það sem þú gast ekki sannreynt og af hverju. Óskráður blindur blettur les eins og þekja

VERKEFNI TIL YFIRFERÐAR:
{{Límdu inn slóð verkefnisins eða lýstu því sem á að fara yfir}}

Leiðbeiningar

Run inside a project directory. The AI will find every documentation file, verify it against the actual code, fix what it can, and report what needs human attention. Great for pre-release documentation audits or onboarding preparation.

Ábendingar

Run this after any major refactor or dependency update. Code changes often leave documentation behind — this prompt catches the drift.

The gap analysis is especially valuable for open source projects. Missing documentation is the number one barrier to contribution.

devopsdocumentationmarkdownreviewquality