Documenting APIs and SDKs
Book Details
Author(s)Manuel Gordon
PublisherThird Wave Studios
ISBN / ASIN097358212X
ISBN-139780973582123
MarketplaceFrance 🇫🇷
Description
This unique workshop-on-a-DVD focuses on how to organize and produce SDK documention, no matter what language the API is written in. It distills tech-writing specialist Manuel Gordon's popular 1-day seminar on 3 hours of professionally edited video and includes an accompanying workbook. Topics covered: * What are APIs and SDKs? Why sell them? Why buy them? * What to put into an SDK * What programmers really want * A real-world case study * Outlining a Developer's Guide * Generating the Reference Manual * Practical advice for documenting APIs, even with a limited knowledge of programming * Strategies for increasing your knowledge * Lively discussion and Q&A The package includes: * Two DVDs with a total running time of 3 hours * Printed workbook featuring PowerPoint slides plus additional reference material * Professionally-edited digital video keyed to the slides * Convenient interface that enables you to --View a continuous presentation --Jump to any slide and associated video clip in particular * Bibliography of related books and Web resources (10 pages) * Glossary of 150 programming terms * 6000 word research study: What Programmer's Really Want (Results of a Needs Assessment for SDK Documentation) * "Getting Started" booklet with training suggestions
