@hrefna What I've learned over the years re writing:
- My writing style is boring.
- Assume no one will read beyond the 1st heading.
- Keep the # of words in the landing page/README and esp the 1st heading very short.
- If RE coding, place a copy-paste friendly example in the 1st heading.
- If rant/doc, write an accurate & *short* TLDR in the 1st heading.
- Do the rest of the docs as you normally would. Expect folks to read them *only* when trouble-shooting.
@bahmanm I had a class in school—Engineering Practicum Introductory Course Sequence—where the professor had us format our final projects in a particular way with an executive summary in front.
If he liked the executive summary enough to give you an A he wouldn't read the rest of what you wrote.
These days it isn't uncommon for me to have an executive summary, a tl;dr, a technical summary, and a 1-page overview. >_>