
Anything That Can Go Wrong: Lessons Learned from A Decade of Toolkit Documentation
http://www.stc.org/confproceed/1999/PDFs/051.PDF
van Oss, Joseph E.
STC Proceedings
1999
Abstract:
Writing software toolkit documentation for programmers is a special challenge and opportunity for technical writers. Compared with writing software documentation for lay users, toolkit documentation is more demanding and exacting. Checking facts and finding tiny errors is like riding a motorcycle through a swarm of gnats. However, for me at least, toolkit writing has opened doors to a larger role and greater input into product design. Engineers treat me like a peer and I get to see into their culture. I know my readers and salespeople need me.