Vill du hantera dokumentationen som kod?
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!