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!

 
Dela på facebook
Dela på twitter
Dela på linkedin
Dela på email

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

Fler inlägg

Lätt att lära och svårt att bemästra

Ett känt mantra inom spelindustrin är att spelen ska vara ”Easy to learn och difficult to master”, även kallat Bushnells lag. Målet är att du ska tycka att är spelet

Docs like code

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

Skriva teknisk dokumentation i Word

Är inte Word gammalmodigt?

Är inte Word helt ute som manualformat? Det finns många avancerade verktyg för teknisk dokumentation. De flesta är xml-baserade som underlättar för single-sourcing, översättning och kanske continuous delivery. Just nu

Hacks för Rubiks kub

Vad vore livet utan hacks?

Jag älskar hacks av olika slag – knep och trick som förvandlar något svårt till något enkelt. Det kan handla om allt från att gnida paraffin på tröga byrålådor, 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.