vegard/synops
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
synops/ops/doc-audit.md
vegard 0a467066ba Synops v2: arkitektur, retninger og dokumentasjon 
Nystart basert på arkitektonisk innsikt fra Sidelinja v1.
Koden er ny, visjon og primitiver er validert gjennom tidligere arbeid.

Inneholder:
- Komplett arkitekturdokumentasjon (docs/arkitektur.md)
- 6 vedtatte retninger (docs/retninger/)
- Alle concepts, features, proposals og erfaringer fra v1
- Server-oppsett og drift (docs/setup/)
- LiteLLM-konfigurasjon (API-nøkler via env)
- Editor.svelte referanse fra v1

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
2026-03-17 06:43:08 +01:00

1.7 KiB
Raw Blame History

Doc-audit — Dokumentasjon vs kode

Hva

Målrettet gjennomgang av docs/-treet for å sikre at dokumentasjonen stemmer med faktisk kode. Mer fokusert enn ryddejobben — kun docs.

Når

  • Månedlig som rutine
  • Etter store refaktoreringer eller arkitekturendringer
  • Når nye docs legges til

Sjekkliste

1. Filreferanser

  • Sjekk alle filstier nevnt i docs — eksisterer de?
  • Sjekk alle komponent-/modul-navn nevnt i docs — eksisterer de i koden?
  • Sjekk alle route-referanser — matcher de web/src/routes/?

2. CLAUDE.md doc-tre

  • Er alle filer i docs/ listet i CLAUDE.md doc-treet?
  • Er det filer listet i CLAUDE.md som ikke eksisterer?
  • Er beskrivelsene i doc-treet fortsatt dekkende?

3. Tekniske detaljer

  • Stemmer database-skjema beskrevet i docs med faktiske migrasjoner?
  • Stemmer API-endepunkter beskrevet i docs med faktiske routes?
  • Stemmer SpacetimeDB-tabeller/reducere i docs med modulen?

4. Setup-docs

  • docs/setup/lokal.md — fungerer stegene fortsatt?
  • docs/setup/produksjon.md — stemmer med faktisk server-oppsett?
  • docs/setup/migration_safety.md — er sjekklisten oppdatert?

5. Proposals

  • Er noen proposals implementert og bør flyttes til concepts/ eller features/?
  • Er noen proposals foreldet og bør slettes eller arkiveres?
  • Er noen proposals egentlig retningsspørsmål og bør flyttes til retninger/?

6. Retninger

  • Er tesene i docs/retninger/ fortsatt relevante?
  • Har noen retninger modnet nok til å påvirke andre docs (arkitektur, features, infra)?
  • Er det nye arkitektoniske spenninger som fortjener en egen retning?

Sist kjørt

Ikke kjørt ennå.