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
- Speaking of the 1990's http://www.hwg.org/ — 4 years 12 weeks ago
- "Oh, I see! You're like a webmaster from the 1990s, except you can't even code HTML." http://bit.ly/dsjBEX #fb — 4 years 12 weeks ago
- Please, please: DO NOT put a hyperlink on a filename unless clicking on said link actually downloads that file. #ihatesourceforge #uxfail — 4 years 12 weeks ago
- RT @ebertchicago:Josh reminds me: If we went back to what the Founding Fathers wanted, as Sarah Palin desires, she wouldn't be able to vote. — 4 years 12 weeks ago
- RT @tommysalami: Great "how I got into horror" blog post by @brittnahjade http://is.gd/c4dj8 Awwww :) — 4 years 12 weeks ago