http://tc.eserver.org/dir/Articles/Documentation/SDK A listing of the most recently indexed works about Articles and Documentation and SDK in the field of technical communication. en-us Copyright (c) 2005-08 by the EServer. All rights reserved. tclib-editorial@eserver.org (TC Library Editorial Board) webmaster@eserver.org (Geoffrey Sauer) http://tc.eserver.org/images/newlogo.gif http://tc.eserver.org/dir/Articles/Documentation/SDK http://tc.eserver.org/33893.html http://tc.eserver.org/33893.html Sample code often provides the quickest, clearest way to learn how an SDK works. If you have software engineering experience, then you should already know many principles for writing good code. However, what you may not realize is that some of the good practices that you learned for writing good production code do not apply to writing good sample code. Some techniques, such as comments and clear variable names, apply to both production code and sample code. However, there are good reasons to use hard-coded values in sample code, which should be avoided in production code, and there are good reasons to avoid object-oriented designs when writing sample code. http://tc.eserver.org/24657.html http://tc.eserver.org/24657.html Here are the ten simple steps to successful software development kit (SDK) documentation. http://tc.eserver.org/24220.html http://tc.eserver.org/24220.html 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. http://tc.eserver.org/21697.html http://tc.eserver.org/21697.html 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). http://tc.eserver.org/14711.html http://tc.eserver.org/14711.html Sarr presents guidelines for the challenging task of creating a software development kit (SDK). The purpose of SDKs, the author writes, is to 'provide developers with information and coding examples to enable them to develop applications that will work with a newly developed technology.'