Leave the sales pitch out of your documentation

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

Syndicate content

Twitter

  • @captain_science so glad you lliked them, especially the bow tie- it was a bit of a crap shoot! 3 years 30 weeks ago
  • Not sure we had enough pie http://flic.kr/p/8WnSf2 3 years 31 weeks ago
  • What part of "don't discuss politics in the lodge" is so &@$!?ing hard to understand? 3 years 33 weeks ago
  • photo.jpg http://flic.kr/p/8Hy5pe 3 years 38 weeks ago
  • It's about time http://flic.kr/p/8GcTJo 3 years 39 weeks ago

Older

Contact

Andy Chase
(978) 297-6402
andychase [at] gmail.com
GPG/PGP Public Key