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

  • Kelmscott Roman is a lovely font: http://bit.ly/9K957g 4 years 12 weeks ago
  • @tommysalami SBD! 4 years 12 weeks ago
  • Exporting ~36,000 images from #filemaker container fields. Hooray for automation! 4 years 12 weeks ago
  • Programming neologisms: I like hot potato/hot potatoes http://bit.ly/biliSO #fb 4 years 12 weeks ago
  • NICE color scheme tool http://colorschemedesigner.com 4 years 13 weeks ago

Older

Contact

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