3 ms·
I appreciate it when creators provide introductory material in a top-down, inverted pyramid style. When I’m reading that sort of documentation, I am probably in
by Chris_Newton 7y ago
I appreciate it when creators provide introductory material in a top-down, inverted pyramid style. When I’m reading that sort of documentation, I am probably investigating tools for solving a problem and perhaps comparing different options. A quick summary that confirms I’ve found the right sort of thing — or that warns me immediately if I haven’t — and that sets out its distinguishing features and priorities is helpful. Following that with an overview of the main concepts and structure with some concise examples of typical use cases gives a flavour of what it’s like to use this tool in practice and provides some context for any larger examples or more comprehensive reference material.
This starts right from the first sentences describing the tool. I am a particular fan of people who don’t hide the purpose of the tool behind several lines of adjectives and credits. The Redis description in the article is exemplary, IMHO.