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

  • On the ground in BOS. they don't call em red eyes for nothing 4 years 17 weeks ago
  • Really? Your ringtone is 'The Star Spangled Banner'? 4 years 17 weeks ago
  • Checked in & through security at OAK. Looking forward to getting home after yet another good #drupalcon. 4 years 17 weeks ago
  • Delving into the #drupal views API. My brain hurts. 4 years 17 weeks ago
  • Would welcome recommendations for example code for defining custom relationships for #drupal views 4 years 17 weeks ago

Older

Contact

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