Reviews


How involved is your Legal department in the review of technical publications (manuals, Quick Start Guides, Service Guides, etc)

Documenting APIs and SDKs: A Review

by Susan W. Gallagher

Information about API documentation is difficult to come by, and a DVD training course is a welcome and significant addition to this meager library. As the marketing literature suggests, individuals can use the video training as a self-paced lecture series, following along in their workbooks as the seminar unfolds on the TV or computer screen. Documenting APIs and SDKs can provide a cost-effective means of bringing a department up to speed or for training new employees as needed. To the manager of an API doc team, it sounds like a dream come true!

Resources - comparing HATS

During my research on HATS for beginners like me, I found these great resources:

List of available HATs for help authors who use MS Word at:
http://www.mshelpwiki.com/wiki/tiki-index.php?page=AvailableTools

List of reviews on many of these HATS:
http://www.mshelpwiki.com/wiki/tiki-index.php?page=SoftwareReviews

I’ve also gotten good insight by emailing authors of software reviews. Many have responded within days and have been helpful.

Mostly however, I’ve found that trying the application is the best way to determine if it’s right for my projects and purposes.

The Inspection Method: An Approach to Planning and Managing a Successful Team Document Review

by Donn Le Vie, Jr.


You know the drill. You develop documents. You send them out for review. Maybe you also include a cover page that details what reviewers should focus on and offers examples of how to (and not to) provide comments. Maybe you ask reviewers to return comments to you. Or maybe you hold the dreaded (play bad horror-movie music here)...team document review. For many of us, a root canal sounds like a more fun and productive afternoon agenda....

Syndicate content