Re:TLDR pages: Simplified, community-driven man pages
by overcast on Wednesday January 22, 2020 @12:51PM
(#22120024)
Just start with the assumption that no one understands how to read a man page and how to translate that into a full command line operation. A simple example goes A LONG WAY.
[ Parent
| on HN ]
Re:TLDR pages: Simplified, community-driven man pages
by Darkphibre on Wednesday January 22, 2020 @01:12PM
(#22120239)
Back in 2000-2005 I worked on the SQL Server documentation.
If I remember correctly, when we instrumented the docs we found that the VAST majority of users skipped over all the descriptions and parameter definitions, and jumped straight to the examples of usage. Turns out observation is the fastest way to learn/remember. We redoubled our efforts to include examples of more obscure usage patterns, rather than relying on wordy explanations.