Giv en fælles Markdown-fil en tydelig vej til publicering
En Markdown-fil kan indgå i både menneskers redigering og automatiske arbejdsgange. Når flere værktøjer kan åbne den, bliver det vigtigt at aftale, hvilken fil der gælder, og hvordan ændringer når frem til den rigtige destination.
1. Udpeg den gældende placering
Beslut, hvor redigering foregår, og hvor den godkendte tekst bruges. Skriv forholdet mellem de to placeringer ned, hvis de ikke er samme sted.
Googles direkte Markdown-redigering i Docs giver en ny anledning til at afklare dette. Guiden er en anbefalet proces, ikke en opskrift på en bestemt integration.
2. Aftal rollerne omkring filen
Udpeg en indholdsejer, en relevant faglig gennemlæser og en ansvarlig for publicering. Én person kan have flere roller, men opgaverne skal være kendte.
Et tænkt eksempel er en produktbeskrivelse, som marketing retter, mens en udvikler overfører den til hjemmesiden. Aftal, hvem der håndterer ændringer, der kommer efter den faglige gennemgang.
3. Brug en repræsentativ prøvefil
Lav et ufølsomt eksempel med de strukturer, destinationen forventer. Medtag relevante overskrifter, links, lister og eventuelle kodeblokke eller tabeller.
Følg filen gennem hele det planlagte forløb og kontrollér resultatet dér, hvor teksten skal bruges. Hvis destinationen kræver særlige felter eller en bestemt opbygning, skal de indgå i prøven.
4. Bind godkendelsen til en version
Gem en versionsreference eller en uforanderlig kopi af det indhold, der blev gennemgået. En besked om, at dokumentet er fint, bliver uklar, hvis teksten ændres bagefter.
Aftal, hvordan nye rettelser bliver vurderet. Det kan være en ny gennemlæsning af de berørte afsnit, hvis ændringen er afgrænset og resten af filen er bevaret.
5. Kontrollér destinationen efter overførsel
Se efter korrekt tekst, struktur og links i den leverede version. Notér hvilken kildeversion den svarer til, og hvem der verificerede den.
Luk først opgaven, når destinationen er kontrolleret. En redigeret fil viser fremdrift i indholdsarbejdet; den beviser ikke alene, at hjemmesiden eller det automatiske system bruger den nye tekst.