3 ms·
I agree with the post. If you consider that your docs are also a form of advertising... don't shoot yourself in the foot and make your readers feel stupid. I
by lucidguppy 3y ago
I agree with the post. If you consider that your docs are also a form of advertising... don't shoot yourself in the foot and make your readers feel stupid.
I would go one step further. If we are talking about CLI tool usage - the cli should have two modes. One interactive using gum or some similar library. Once complete - it should output the non-interactive equivalent CLI command.
The interactive run should give short explanations to help learn the tool.
The takeaway point is that docs are partially advertisements - and if you don't want to lose people - your docs have to be carefully crafted.