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

  • If you write/perpetuate #freemason conspiracy theories on the internet, you're kind of an idiot. 4 years 10 weeks ago
  • Holy #draggableviews module for #drupal, Batman! 4 years 11 weeks ago
  • Brimfield Treasure http://flic.kr/p/82G1Sr 4 years 11 weeks ago
  • I checked in at Francesco's Italian Restaurant (RR 20) on #Yelp http://bit.ly/b1Mhkx 4 years 11 weeks ago
  • @walkah The @NHLBruins don't make it easy to be a fan, do they? 4 years 11 weeks ago

Older

Contact

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