Plus, the first approach means more work to do, which theoretically means more employment for myself and my fellow tech writers! Solidarity, my brothers and sisters!Īnyway, while I do prefer the first school, this approach sometimes leads to amusing results. This is not to say some projects shouldn’t go the other way, but for the most part, I think more information is good. Basically I figure that people are grownups, and if you do your best to explain things, hey, it’s their lookout.
For example: is it better to document every API method or option, no matter how obsolete or dangerous? (Otherwise known as the “Give them rope and explain how they can tie their own noose” approach.) Or should you try to hide all the bad stuff for the user’s own good? (Otherwise known as the “ Allanon School of Technical Writing.”) And no field is more fraught with ethical conundrums than… technical writing. So this is the time of year when all Nice Jewish Boys (and Girls) should turn their minds to ethical questions.
0 kommentar(er)
