Vill du hantera dokumentationen som kod?

Docs like code

Jobbar du på ett mjukvaruföretag? Funderar du på hur ni skulle kunna organisera och hantera er tekniska dokumentation på ett smart sätt? Då kanske konceptet Docs like code kan vara något för er.

Vad är poängen med Docs like code?

En grundläggande princip i Docs like code är som det låter: du hanterar dokumentationen precis som om den vore kod. Det innebär att om du är utvecklare och ska dokumentera så ska du inte behöva byta kontext för att öppna ett annat program för att skriva och hantera din dokumentation. 

När du inte behöver byta kontext kommer dokumentationen in i samma flöde som koden. Det gör också att ni kan testa dokumentation i samma flöde som koden, vilket i sin tur gör att ni inte bara kommer att ha mer dokumentation, utan den kommer säkerligen vara mer korrekt också!

Se video om Docs like code

Jag rekommenderar att du tittar på den här presentationen där Mason Egger berättar om hur de hanterar Docs like code i samband med Continuous integration och Continuous deployment (ibland även kallat Continuous delivery).

Presentationen är intressant, kul och effektiv (jag ÄLSKAR när folk pratar snabbt!), så det är väl investerade 29 minuter:

 

Läs mer om Docs like code

Du kan också läsa mer om Docs as Code på organisationen Write the docs webbplats:

https://www.writethedocs.org/guide/docs-as-code/

Kom personligen på meetup och lär dig mer!

Om du nu har blivit nyfiken på vad Docs like code är och hur andra har gjort, kom på meetup i Stockholm den 26 september och ta del av andras erfarenheter och frågor!

Läs mer om meetup och anmäl dig här!

 

Jag hjälper dig med metoder, kunskap och erfarenheter kring produktdokumentation så att den blir både effektiv och användbar.

Fler inlägg

Hieroglyfer

Docs or it didn’t happen

”Jag lovar, vi har gjort riskanalyser.” Ett sånt uttalande räcker inte långt vid en revision, om du inte kan visa upp dokumentationen som bevisar det. Och då kan hela projektet

Ren instruktion

Håll instruktionen ren

Blir dina instruktioner långa och komplicerade? Det är lätt hänt, eftersom det ofta finns så mycket att förklara för användaren, annars hade du ju inte behövt skriva instruktionen från första

Elbil

Läsa, förstå och komma ihåg?

Jag fattar inte varför vår elbil inte har växlar, jag erkänner. Förut tänkte jag att den var automatväxlad, men vet numera att så inte är fallet. Den har helt enkelt

Buffe med mat

Därför ska du skriva manualen som en buffé

Jag är en förespråkare av modulär teknisk dokumentation. Varför? För att det gör dokumentationen lättare att använda, lättare att skriva och framför allt lättare att uppdatera. Hur då? Modulärt julbord

Instruktioner för att laga soppa

User stories ger dig rätt instruktioner (del 2)

User stories visar vad er produkt faktiskt ska uträtta åt användaren. Eller snarare vad användaren vill göra. Du kan nu enkelt förstå vilka instruktioner som du behöver skriva. Välkommen till

Gunilla Svanfeldt Omslag

Samtycke till marknadsföring

Vi lagrar informationen som du anger i formuläret för att kunna kontakta dig med nyhetsbrev, om uppdateringar och med erbjudanden. 

Markera kryssrutan i formuläret för att ge ditt samtycke till att vi skickar e-post till dig.

We use MailerLite as our marketing automation platform. By clicking below to submit this form, you acknowledge that the information you provide will be transferred to MailerLite for processing in accordance with their Privacy Policy and Terms of Service.