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 @eaton: Couch Cushion Architecture: A Critical Analysis. http://is.gd/bLPfU — 4 years 16 weeks ago
- I'm sure Droid is a very nice phone, but the ads make me think I'm going to be captured by robots and plugged into the Matrix. #fb — 4 years 16 weeks ago
- RT @Dries RT @robertDouglass: @horncologne single-handedly completes the Drupal.org redesign: http://is.gd/bLAyq #drupal — 4 years 16 weeks ago
- @lucidus_neil Are there any further Keene #drupal user group meetings on the horizon? — 4 years 16 weeks ago
- RENE RANCOURT IN THE HIZZOUSE! #fb — 4 years 16 weeks ago