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

  • Suddenly remembering that it was #followfriday and not having recommended anyone in a while, He directed you to @VeryShortStory. 4 years 9 weeks ago
  • I've been coding up a storm this week. #fb 4 years 9 weeks ago
  • WE ARE HAPPY TO SERVE YOU :( http://www.nytimes.com/2010/04/30/nyregion/30buck.html?hp #iconic #design 4 years 9 weeks ago
  • RT @eaton It's probably unecessary to generate a unique key pair for my cat, but better safe than sorry. 4 years 9 weeks ago
  • Interesting discussion on loading #drupal CCK field widgets manually: http://bit.ly/c7ICM5 4 years 9 weeks ago

Older

Contact

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