image representing a theme in this article
image representing a theme in this article
image representing a theme in this article
image representing a theme in this article
Technical Writing Training  
api documentation | training | learn
Technical Writing Training  
API Documentation Certification Course
Name:
Certificate Course in API Documentation
Certificate Available:
2 Weeks (10 sessions of 1 hour each)
Pre-requisites:
Candidates should have some experience/knowledge in Technical Writing
Hands-on Training:
It is a Hands-on training program, therefore, apart from the conceptual knowledge, you will be made to create API documentation for real APIs.
The aim is to make you undergo the whole life-cycle of creating API documentation to instill confidence in you
It is a personalized course. So one senior and highly experienced instructor will work with you exclusively to train you. So its one trainee - one instructor
Training Methodology:
The training will be imparted through web-conferencing tools such as google meet or skype. You will be able to see and talk with the instructor. The instructor in turn will be able to see the work you are doing on your system and guide you
This is a personalized course, so the trainer will work with you exclusively and move keeping in view your strengths and weaknesses
The training will be hands-on. Therefore, to develop your skills, you will be given tasks and exercises during the training session
You will also be given assignments that you will have to do after each session and before the next session. These will be evaluated by your instructor
You will be free to clarify your doubts during the session.
Assignments:
During the course of training, you may be given assignments that you would be expected to complete before the next session
Cost:
Rs. 18,000/- (USD $275 for candidates outside India)
To be paid through wire transfer at the time of registration. Contact us for more details

Syllabus

Understanding API
  • What is API
  • Types of API
  • Current Trends
Understanding API Documentation
  • Purpose of API Documentation
  • Overall structure of API Documentation
  • Documentation elements of each API
  • Standards for API dodcumentation such as RAML, Swagger
Acquiring API Knowldge
  • Paradigm Shift – Understanding what you cannot see
  • Tools to view APIs
Planning API Documentation
  • Desiging Documentation Structure
  • Identifying API patterns
  • Deciding the documentation format
  • Tools for API documentation
Creating and Reviewing API Documentation
  • Identifying single-use and re-usable elements
  • Documenting each Element of API pattern
  • Documenting examples and sample code for APIs
  • Planning single-sourcing for API documentation
  • API Documentation and DITA/XML