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
- Comcast cable & Internet down in Winchendon MA, 3rd time this week. Gives one pause re: switching to their phone service. #fb — 3 years 51 weeks ago
- I just became the mayor of Beals Memorial Library on @foursquare! http://4sq.com/bpXyNX — 4 years 1 day ago
- I just became the mayor of Winchendon Field Office on @foursquare! http://4sq.com/aUMCCT — 4 years 4 days ago
- Hay baled fresh off the field -- we live in an awesome place. http://flic.kr/p/8hZF6t — 4 years 5 days ago
- Just picking up hay, honestly! (@ Murdock Dairy Farm) http://4sq.com/b9yjcJ — 4 years 5 days ago