IT SOLUTIONS
Your full service technology partner! 
-Collapse +Expand
Tech Writer
Search Tech Writer Group:

Advanced
-Collapse +Expand Tech Writer Store

Prestwood eMagazine

June Edition
Subscribe now! It's Free!
Enter your email:

   ► KBRole-Based T...Technical Wr...   Print This     
  From the October 2008 Issue of Prestwood eMag
 
Tech Writer Technical Writing:
API documentation - documenting the program code
 
Posted 12 years ago on 10/1/2008 and updated 3/25/2009
Take Away:

Overview and tips for documenting an Application Programming Interface (API).

KB101312

Application Programming Interface (API) documentation provides information pertaining to the interfaces/classes/functions/objects used within the program module or for specific software application/product. Over a period of time, the developers/testers may not be able to remember all the API references. Hence, it is important to have this information stored and maintained in order to track changes between versions and able to manage this API information.

API documentation refers to documentation of the  software code. API includes interfaces, methods, classes and other user defined functions. It is important for developers to have this information being documented as they might not be able to remember all the API references and its related interfaces, classes, etc.

A technical writer working on API documentation needs to be well focussed towards the programming standards and understand the product architecture. The writer would be spending 50% of his time towarda analysis and understanding the code/APIs, 40% of the time will be spent towards documenting this code and 10% for the reviews.

As changes occurs with versions, service packs and new release over a period of time, it becomes necessary to update the existing documentation.

A writer needs to have this checklist in order to have a complete understanding of the ongoing API documentation:

  • Understand the software life cycle process
  • Glossary of the software terminologies
  • Product knowledge - architecture, specification
  • Programming language constructs
  • Definitions used in the programming language
  • Domain knowledge
  • End user requirements towards documentation
  • PM Process requirements and life cycle
  • Template/style guide for documentation

Comments

1 Comments.
Share a thought or comment...
First Comment
Comment 1 of 4

The problem of hair fall is everlasting. You would come across every woman complaining about having hair fall. Well, you can‘t get rid of this problem all by yourself you have to look for a hair specialist in Karachi to examine what‘s wrong with your scalp and get rid of this problem quickly.

Posted 5 months ago

Comment 2 of 4

Is vacuuming carpets enough?

Honestly speaking, vacuuming your carpet is never enough. They also need something extra or some effective cleaning solutions which can remove all the dirt properly. This would only become possible when you look for carpet cleaning.

Posted 5 months ago

Comment 3 of 4

These days you will come across many companies that can help you start with your social media presence. So, make sure that you hire a social media agency, who would help you in handling all your business operations online. Besides, they would also help you grab some potential customers from the online world.

Posted 5 months ago

Latest Comment
Comment 4 of 4

I really like reading an article that will make men and women think. CSC Online Apply Also, thanks for permitting me to comment!

Posted 18 days ago
 
Write a Comment...
...
Sign in...

If you are a member, Sign In. Or, you can Create a Free account now.


Anonymous Post (text-only, no HTML):

Enter your name and security key.

Your Name:
Security key = P156A1
Enter key:
KB Post Contributed By Ramesh R:
Visit Profile

 KB Article #101312 Counter
9479
Since 10/1/2008
Sales Website: www.prestwood.com Or visit our legacy sales site: 
legacy.prestwood.com


©1995-2020 Prestwood IT Solutions.   [Security & Privacy]