Intro to phases of creating API documentation

Subject: Intro to phases of creating API documentation
From: "Anna Junglas" <ajunglas -at- hotmail -dot- com>
To: "TECHWR-L" <techwr-l -at- lists -dot- techwr-l -dot- com>
Date: Tue, 08 Nov 2005 11:26:10 -0800


I?d like to understand the basic phases of creating API documentation for a Java application.
 
Setup
What are the tools I?ll need? (Java Doc, a version control system, an IDE) How many different kinds of docs are usually produced in an SDK kit? What is the main purpose of each?
Anybody know of a good example of SDK documentation?
 
 
Orientation
Is there a good glossary of terms that I can study?
What happens on the first day?
Who should I talk to first? What should I expect to receive from this person?
Who should I talk to next?
Should I ask for an explanation of the modules?
Is it usually acceptable for a technical writer to sit in on code reviews?
 
 
?Writing?
I assume I?ll be expected to look at the code and tweak the comments - - how do I ask for the location? - meaning do I say something like - ?what?s the path in the version control system to the view the code??
How common is it to have UML diagrams in an API doc? Is this generally created by the engineers? What tools do I need?
I have run JavaDoc - it magically pulls comments out of the code and formats them. What kind of information do I need to collect in order to populate those fields in the first place?  Is ALL of the content stored in the code or are there pieces that I?ll have to add after JavaDoc runs?
 
I?ve heard that examples are very important. Any tips in this area?
Tips on documenting logging?
 
What else?/What?s next?
 
 
 
With great appreciation,
Anna



^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

Try WebWorks ePublisher Pro for Word today! Smooth migration of legacy
RoboHelp content into your new Help systems. EContent Magazine Decision-
maker review (October 2005) is here: http://www.webworks.com/techwr-l

Doc-To-Help 2005 converts RoboHelp files with one click. Author with Word or any HTML editor. Visit our site to see a conversion demo movie and learn more. http://www.componentone.com/TECHWRL/DocToHelp2005

---
You are currently subscribed to techwr-l as:
archiver -at- techwr-l -dot- com
To unsubscribe send a blank email to leave-techwr-l-obscured -at- lists -dot- techwr-l -dot- com
Send administrative questions to lisa -at- techwr-l -dot- com -dot- Visit
http://www.techwr-l.com/techwhirl/ for more resources and info.



Follow-Ups:

Previous by Author: AW: {*} GUI elements - how do you format them in your docs?
Next by Author: FW: bidding a first contract
Previous by Thread: Re: Dual-use font
Next by Thread: Re: Intro to phases of creating API documentation


What this post helpful? Share it with friends and colleagues:

Sponsored Ads


Sponsored Ads