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
- RT @MJMcKean: #nonthreateningpirates Captain Kidding — 4 years 10 weeks ago
- Remember the dark ages, when mouseover button changes required 1) Actual <img> tags and 2) Javascript? Usually inside a nested table. #fb — 4 years 10 weeks ago
- A most helpful guide to #drupal 6 menu theming: http://bit.ly/cxmtb8 — 4 years 10 weeks ago
- Welcome back, Savvy!!! #bruins #fb — 4 years 10 weeks ago
- @webchick Try local brick and mortar consignment shops. I've seen some around central Mass. that advertise ebay services. — 4 years 10 weeks ago