APPLY
Explain something to another person
Choose the structure and depth your reader needs.
Start here
Diátaxis
Choose documentation around whether someone is learning or working, and doing or understanding.
First decide whether the person needs to learn, act, look something up, or understand why. Then choose vocabulary and detail for that reader rather than merely shortening the text.
This recommendation fits when
You know the subject but need to communicate it to someone with different prior knowledge.
Choose differently when
If you need a decision rather than an explanation, use the decision guide. If the reader needs only a precise value, lead with the reference answer.
A practical route
- Name the audience and their existing knowledge.
- Choose a documentation purpose.
- Show one concrete example and preserve necessary terminology.
- Ask the reader a small question to check the intended understanding.
Useful companions
Plain language
Help the intended reader find, understand, and use the information they need.
Progressive disclosure
Reveal detail when it becomes useful while keeping essential information easy to find.
This is an editorial recommendation for the stated situation. It is not a personalized diagnosis or a ranking of all methods.