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

  • I'm at Lucky Dragon (222 baldwinville state road, Winchendon). http://4sq.com/bprJh8 4 years 7 weeks ago
  • Handy bookmarklet for toggling bunches of web checkboxen: http://bit.ly/c0hrVm 4 years 7 weeks ago
  • Wicked helpful #drupal module: multicolumncheckboxesradios http://bit.ly/cym0zU 4 years 7 weeks ago
  • No. 0495 http://flic.kr/p/87V8Uv 4 years 7 weeks ago
  • Today's "hey, somebody already solved this for me!" #drupal community awesomeness: Dirty Forms module. http://bit.ly/9J8xNK 4 years 8 weeks ago

Older

Contact

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