Skrivande

Så skriver du dokumentation som faktiskt läses

Så skriver du dokumentation som faktiskt läses

Dålig dokumentation är sällan ett kunskapsproblem utan ett strukturproblem. Diátaxis-ramverket, som delar upp dokumentation i handledningar, guider, referens oc...

Dålig dokumentation är sällan ett kunskapsproblem utan ett strukturproblem. Diátaxis-ramverket, som delar upp dokumentation i handledningar, guider, referens och förklaring, har blivit en spelväxlare för många team.

Skriv för läsarens situation, inte för din egen. Den som felsöker klockan tre på natten behöver något helt annat än den som utvärderar verktyget första gången.

Och viktigast av allt: dokumentation som inte underhålls är värre än ingen alls. Gör den till en del av definition of done.