Hey all, I’m still a junior dev with years of experience in IT. One of the things I’ve noticed since making the switch is that (at least where I work) documentation is inconsistent.
Things I encounter include incomplete documentation, outdated documentation and written process details that have assumed knowledge which makes it difficult for junior Devs to pick up.
I’ve had a search and a lot of what is out there talks more about product and how to document that SDLC rather than best practice in writing and organising documents against the actual software engineering and its processes.
Does anyone have any good sources or suggestions on how I could look to try and begin to improve documentation within my team?
Be bold and make changes. Document what you find out, what is outdated, what is missing.
Take ownership. If there’s nobody that oversees overall structure, be the one to do so - at least where you’re touching it or are being bothered by it.
Diatraxis gives some great insight and considerations input into writing and structuring documentation. Namely how different target audiences and doc use cases require different forms and detail levels of guidance.
My company’s internal doc/guidance also links to https://www.writethedocs.org/guide/ which seems like a good source.
Thank you for those links, it has given me a great place to get stuck into!
Sort of interesting that this documentation system appeared in two different places that don’t seem to reference each other.
https://docs.divio.com/documentation-system/