Leave the sales pitch out of your documentation
27 Jul, 2006
When reading software or programming language documentation and how-tos, I find phrases like "Doing X in Bob's Wonder Suite is as simple as clicking Y" rather irksome.
If it's really true that all I need to do is click Y, then it will be pretty clear to me how simple it is, won't it? Just say "To do X, click Y", give it a useful index entry, and have done with it.
Also
- Login to post comments
Popular
Recently Perused
- Why did it take me this long to realize that MultiMarkdown will convert Markdown to Latex for you? Intriguing possibilities. — 4 years 9 weeks ago
- Protip: Don't use a handy drupal form screenshot to test a CCK imagefield... "WHERE ARE THOSE WEIRD FIELDS COMING FROM???" — 4 years 9 weeks ago
- Burt Mustin sighted in an Adam 12 rerun! — 4 years 9 weeks ago
- George Wendt and William Atherton in 'Re-animator: The Musical'. What more needs to be said, really? #fb — 4 years 9 weeks ago
- Sam Adams Noble Pils after working all day in the sun? Yes sir. — 4 years 10 weeks ago