4 ms·
We have technical writers who work in conjunction with developers to author the documentation. I don't know what tool they use. However, since you say you want
by NearAP 11y ago
We have technical writers who work in conjunction with developers to author the documentation. I don't know what tool they use.
However, since you say you want to get better at writing docs, let me offer some perspectives based on a user of documentation.
1) Write to all of your target audience. For example if your product is targeted at both technical and non-technical people, then write the documentation in such a way that non-technical folks can understand it. Don't just write for the technical people.
2) If possible, write documentation around several 'how do I do XYZ task'? My experience has been that people tend to turn to documentation when they want to execute a specific task and they tend to search for those phrases
3) As much as is possible, include examples. This tends to remove ambiguities.
- brwr 11y agoThat's really good advice. I also want to add a ton of documentation around the "Why?" factor. Why did we make this decision? Why are we using this technology? etc. The first question is always "How do I do this?". The second question is almost always "Why do I have to do it that way?". ;)