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

  • It's about time http://flic.kr/p/8GcTE9 3 years 39 weeks ago
  • Don't use twitter much any more, ayuh. 3 years 41 weeks ago
  • Lazyweb: Does there exist a #drupal module for selectively disabling CCK fields without deleting them? Perhaps field permissions... 3 years 41 weeks ago
  • New post: Old Joe (Minstrel Banjo) http://tinyurl.com/3yyg8g9 3 years 44 weeks ago
  • New post: Emacs Org-mode: Custom agenda that filters by date AND tag http://tinyurl.com/2vnrcl2 3 years 44 weeks ago

Older

Contact

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