Why document¶
TODO: Link to write the docs page
My Journey¶
What lead me to this¶
- It's hard to do your job if there's no docs
- It's frustrating when you used to know how to do something and you don't anymore
What I had
Management at our company was really pushing for documentation changes
They created a dev-docs repo and I was just continuing what they started after it seemed like it stalled.
I also put a ton of personal time into this which isn't a sustainable pace.
Changing the culture¶
- Got obsessed and watched a ton of write the docs talks
- Took notes
- Doc audit
- Doc survey
- Is there really a problem?
- Sample questions
- Mkdocs POC
- MKDocs integration
Last update:
2023-04-24