Ga naar inhoud

De opslag, het wiki en deze documentatie

Machinevertaling van het Franse origineel.

Drie plekken, die vaak verward worden, maar die niet hetzelfde dienen. De vraag "Waar schrijf ik dit?" kan in één zin beantwoord worden, maar het is belangrijk om deze vraag te stellen: kennis die op de verkeerde plek is opgeslagen, is niet verloren, maar is simpelweg niet te vinden wanneer je hem nodig hebt.

Wat elk dient

flowchart LR
    travail["Session de travail<br/>incident, décision, mesure"]

    subgraph vault["Vault Obsidian — la mémoire"]
        notes["≈ 5 100 notes<br/>incidents · decisions.md · faqs/"]
    end

    wiki["Wiki (Wiki.js)<br/>≈ 5 100 pages<br/>resynchronisé chaque nuit"]
    doc["Cette documentation<br/>25 pages<br/>écrite à la main"]

    travail -->|"en continu,<br/>pendant qu'on agit"| notes
    notes -->|"automatique<br/>miroir nocturne"| wiki
    notes -.->|"à la main,<br/>quand ça se stabilise"| doc

    wiki --> lire["Retrouver<br/>« que s'est-il passé ? »"]
    doc --> faire["Agir<br/>« comment je fais X ? »"]

De pijl naar het wiki is volledig: het is automatisch, er is niemand die beslist. De pijl naar de documentatie is puntgewijs: het gaat ervan uit dat er iemand is die leest, herschrijft en beslist wat gepubliceerd moet worden.

De opslag en het wiki hebben dezelfde omvang, en dat is geen toeval: het wiki bevat alle versie-notities van de opslag, behalve die welke door een privacyfilter worden verwijderd. Wat hen onderscheidt, is niet de inhoud, maar het gebruik.

Opslag Wiki Deze documentatie
Natuur Werkgeheugen Toegankelijke archief Handleiding
Voedingsbron Continu, tijdens het werk Afgeleid van de opslag, elke nacht Handmatig, wanneer het stabiel is
Omvang ≈ 5.100 notities ≈ 5.100 pagina's 25 pagina's
Wordt er teruggelezen? Nee Nee Ja
Tijd Gedateerd — "24 augustus…" Gedateerd Heden — "Zo doen we"
Waar open je het voor? Schrijven Vinden Doen

De test die het verschil maakt

De korte formulering

Deze documentatie beantwoordt vragen die je kunt stellen voordat je de omgeving kent. Het wiki beantwoordt vragen die ervan uitgaan dat je de omgeving kent.

De vraag De locatie
« Hoe publiceer ik een service? » documentatie
« Waarom duurde het 40 minuten om op 30 augustus de docs te laten werken? » wiki
« Waar bevindt het Compose-bestand van een stack zich? » documentatie
« Wat was onze beslissing over LightRAG? » wiki
« Welk SSH-poortnummer is er voor vm-docker? » documentatie
« Wat is er misgegaan tijdens de Headscale-migratie? » wiki

Handige bijkomst: Een pagina in deze documentatie die een datum bevat, is waarschijnlijk een verborgen wiki-notitie. De datums zijn legitiem om een meting te beschrijven (« gemeten op 2026-08-27»), maar nooit om een verhaal te vertellen.

En de ongeveer 1.700 FAQ's

Die blijven in de vault, en dus in de wiki. Ze hebben hier niet hun plaats, om een natuurlijk, niet volumineus, reden.

Een FAQ (veelgestelde vragen) is een object dat gedateerd en specifiek is: het is ontstaan door een incident, het bevat de relevante informatie, en stelt: "Dit is wat we dachten, dit is wat we gemeten hebben, dit was fout". Dit verslag is waardevol, en het is een soort wiki.

Wat deze documentatie waard maakt, is de regel: de FAQ bevat de informatie, en is beschikbaar wanneer iemand deze nodig heeft.

« Une émission acme.sh échoue Timed out waiting for DNS parce qu'AdGuard bloque le résolveur DoH » — 90 lignes : le symptôme, les fausses pistes, les trois pièges enchaînés, ce qui a été essayé, la date.

Un encadré de dix lignes dans Publier un nouveau service, à l'étape du certificat : --dnssleep est obligatoire, voici la commande qui tranche, voici le correctif durable.

La règle opératoire

Une FAQ consultée deux fois est une page de documentation qui manque.

Niet "een FAQ kopiëren hier": een regel die moet worden toegevoegd aan de relevante pagina.

Waarom beide niet gepubliceerd mogen worden

Beide zijn gebaseerd op Authentik, en dat is bewust.

De waarde van deze documentatie ligt precies in wat deze onuitgegeven maakt: de exacte adressen, poorten, paden, het feit dat de edge een NAS is. Een versie zonder al deze informatie zou geen handleiding zijn – slechts een algemeen tekst, waar niemand hier een reden voor zou hebben om naar te kijken.

De daadwerkelijk te publiceren informatie bestaat, maar het is geen derde website

Sommige waarheden die hier worden ontdekt, bevatten geen adressen en zijn van toepassing op iedereen:

  • acme.sh geeft code 0 weer als de certificaatinstallatie is mislukt;
  • een act_runner heeft een unieke reikwijdte, en uitvoeringen queued lijken niet op een fout;
  • een DNS-filter tegen omzeiling kan het hulpmiddel dat de certificaten van het systeem uitzendt blokkeren;
  • een documentatiethema kan stoppen met het weergeven van zijn diagrammen zonder een enkele foutmelding te schrijven.

Dit is materiaal voor een artikel, niet voor een extra website om te onderhouden. Het gemeenschappelijke kenmerk van deze vier is dat ze fouten zijn die niet voorspeld kunnen worden.

Samenvattend

  1. We schrijven in de vault terwijl we werken – altijd, zonder erover na te denken.
  2. Het wiki houdt zichzelf bij. Geen actie nodig.
  3. We promoten hier wat stabiel is en iemand kan helpen – door te herschrijven, nooit door te kopiëren.

Dernière vérification de cette page : 2026-10-06