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

  • No offense to random strangers who email me, but no I don't have "5 minutes" to provide you with free #Drupal phone tech support. #fb 4 years 4 weeks ago
  • Totally blown away by the speed with which Git just pushed data for 7000+ files to a remote master. #fb 4 years 4 weeks ago
  • lolmanny #fb 4 years 4 weeks ago
  • I just ousted @codeslave as the mayor of Hungry 4 Pizza on @foursquare! http://4sq.com/ba7hBm 4 years 4 weeks ago
  • Awww yeah http://flic.kr/p/8c3Xbs 4 years 4 weeks ago

Older

Contact

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