Documentatie bijhouden
Het docs-as-code en CMS-proces voor actuele Tekniq Help.
Tekniq Help gebruikt één Git-geschiedenis voor handmatige en geautomatiseerde documentatie.
Bij een productwijziging
Classificeer de wijziging als:
- geen gebruikersimpact;
- bestaande pagina bijwerken;
- nieuwe pagina nodig;
- release-note nodig;
- afgeschermde technische uitleg nodig.
Een pull request of automatisering mag een concept voorbereiden. Publicatie volgt pas na controle op juistheid, doelgroep, toegangsclassificatie en gevoelige gegevens.
Zelf een pagina toevoegen
Een redacteur opent /admin/index.html, kiest Openbare help of Afgeschermde producthelp, vult titel, doelgroep, bronrepository en inhoud in en slaat de pagina op. TinaCMS schrijft de wijziging terug naar Git, waarna CI de site opnieuw bouwt.
Bron blijft leidend
Helptekst vat de actuele productbron samen. Als documentatie en implementatie elkaar tegenspreken, wordt eerst de productbron gecontroleerd en daarna de help bijgewerkt.
Leg bij een inhoudelijke controle de productrepository, commit en gebruikte bronbestanden vast. Documenteer geen ontwerpvoornemen alsof het al beschikbaar is.
Screenshots
Gebruik alleen een screenshot van een scherm dat op de actuele applicatie is geopend. Werk met herkenbare testdata en controleer dat geen klantgegevens, e-mailadressen, tokens of andere gevoelige informatie zichtbaar zijn. Als een afgeschermd scherm niet toegankelijk is, wordt het niet nagebouwd voor de documentatie.