/Ted Sanders

What Makes Documentation Good tl;dr: From the team at OpenAI: Make docs easy to skim, write well and be broadly helpful. Starts with: (1) Split content into sections with titles. (2) Prefer titles with informative sentences over abstract nouns. (3) Include a table of contents. (4) Keep paragraphs short. (5) Begin paragraphs and sections with short topic sentences that give a standalone preview. (6) Put topic words at the beginning of topic sentences. (7) Put the takeaways up front. (8) Use bullets and tables. (8) Bold important text.

featured in #540