2 ms·
Documentation should have screenshots. Even more important - documentation should have examples of what valid parameter values are. Probably my biggest pet pe
by RajT88 3y ago
Documentation should have screenshots.
Even more important - documentation should have examples of what valid parameter values are. Probably my biggest pet peeve in docs is describing what a param value should be, but leaving it up to you to figure out what that actually means. Sometimes there's a certain format expected, or several candidates for the parameter value.
It drives me up the wall, that there can be very verbose documentation, and you still often don't get the parameters right on the first (or third) try.
This article for example is doing it right:
https://learn.microsoft.com/en-us/previous-versions/windows/it-pro/windows-server-2012-r2-and-2012/cc990289(v=ws.11)#examples https://learn.microsoft.com/en-us/previous-versions/windows/...
- bbds 3y agooh yes, 100% agree. Few months back I was given link to a repository in which I needed to add a configuration file in yaml format. In repository readme first thing I saw was a screenshot of a text editor with possible yaml objects and properties and a text description for them, second was a paragraph of vague description on how the tool that consumes this repo works. No text on yaml structure in readme, no schema, no validation, nothing.