2 ms·
We use a wiki where everybody can update, without any review process. My personal preference is to try to write the docs from a "customer" perspective, i.e. no
by ecesena 9y ago
We use a wiki where everybody can update, without any review process.
My personal preference is to try to write the docs from a "customer" perspective, i.e. not for me that I know the system, but from the perspective of another employee that sees an issue and finds my page.
This means:
- keywords in the title, so the search autocomplete hopefully will find the page in the first results
- short and sweet, meaning that if a process is more than 3-5 steps, the person won't read/understand it. It's better to improve the process than to provide better docs
- when I read something that doesn't work, I do my best to fix it, even if I'm in a rush