Audience
https://developers.google.com/tech-writing/one/audience
good documentation = knowledge and skills your audience needs to do a task − your audience's current knowledge and skills
- make sure documentation provides information your audience needs that they don't already have.
1. Define your audience
- begin with identifying audience
- e.g. software engineer, scientists etc.
- proximity of knowledge for the audience.
2. Determine what your audience needs to learn
- After reading documentation, the audience will learn following:
3. Fit documentation to your audiene
- vocabulory and concepts
- avoid curse of knowledge
- simple words
- cultural neutrality and idioms
- audience should not learn NASCAR, cricket or sumo to read documentation
- avoid idioms and phrases whose meaning differ
- e.g. a piece of cake: US
- Bob's your uncle: UK