Leave the sales pitch out of your documentation
27 Jul, 2006
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
- Login to post comments
Popular
Recently Perused
- @mikesusz Yes, I get a craving for grape soda about once a year. — 4 years 17 weeks ago
- Table Lodge http://flic.kr/p/7W1ADg — 4 years 17 weeks ago
- Note to social media adopters: frequent messages bugging me to do or buy stuff sent via facebook are still pretty much spam. — 4 years 17 weeks ago
- @prouty lots of D7 goodness at #drupalcon sf. Twice as many people, a lot harder to bump into anyone. — 4 years 17 weeks ago
- Back in the Winch after #drupalcon. So is Chicago 2011 a sure thing yet? #fb — 4 years 17 weeks ago