3 ms·
Writing accessible documentation. Most people either write no docs or they write a doc that assumes the reader already knows what the thing is. I write docs t
by dharmab 7y ago
Writing accessible documentation.
Most people either write no docs or they write a doc that assumes the reader already knows what the thing is.
I write docs that assume you're a new employee and explain the thing in simple, plain English before building up the technical details.
Notably, these kind of docs make it easy to handoff maintenance and further development to someone else so you can move on to new projects.
- Ididntdothis 7y agoI have found that just a few informal lines are often very good. What does the code do? How to build? Quick architecture overview. How do components work together? Good devs can usually quickly pick up from there.
- vidanay 7y agoFor user facing documentation, always ask Karen in accounting to read through it and provide her opinion.
- chrischattin 7y agoI really appreciate people like you.
- krishna0512 7y agoThanks a lot for your hard work!! It's because of people like you that I have a very good life.
- rorykoehler 7y agoI wish I knew more people who think like you.
- DerekQ 7y agoHow are you storing and sharing these docs? Is it a common Sharepoint library or something similar? I've found the biggest problem is often getting people to look at the document resource / archive when they have a problem whose solution might already be documented.