A directory of resources inthe field of technical communication (and technical writing).

Articles>Documentation>SDK>Technical Writing

3 found.

About this Site | Advanced Search | Localization | Site Maps

 

1.
#24220

Anything That Can Go Wrong: Lessons Learned from A Decade of Toolkit Documentation   (PDF)

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.

van Oss, Joseph E. STC Proceedings (1999). Articles>Documentation>SDK>Technical Writing

2.
#21697

An Introduction to API Documentation   (PowerPoint)

This session will help you to: identify relevant source of information; extract information from the source; create effective API documentation; create context-sensitive help for DLLs (Dynamic Link Library).

Dubey, Akash. STC India (2003). Articles>Documentation>SDK>Technical Writing

3.
#24657

Software Development Kit (SDK) Documents in 10 Simple Steps

Here are the ten simple steps to successful software development kit (SDK) documentation.

Buck, Catherine. KeyContent.org (2004). Articles>Documentation>SDK>Technical Writing

There are 19 readers currently online: 1 registered user and 18 guests. Register.Follow us on: TwitterFacebookRSSPost about us on: TwitterFacebookDeliciousRSSStumbleUpon