Certificate Program in API Writing
Start date:
October 5, 2020
Duration:
14 hours
Weekdays:
9:30 am- 10:30 am
Course Detail
- What is an API?
- Who uses API documentation?
- What do they want?
- Types of API writing
- Why is there a need for API writing?
- Essential skills for an API writer
- Different types of API documents
- Writing API documentation
- What content goes into an API document?
- Common structures for API documents
- Automatically generated content
- Manually written content
- Writing the content
- Code samples
- Design patterns in the API documentation
- Standards and emerging conventions
- Designing the content to meet the audience’s needs
- Authoring tools
- Creating API content
- API specification tools
- Publishing the content
- Managing the content
- Automation tools
- Mixing automatically generated content with hand-crafted content
- Editing and reviewing content
- Maintaining the documentation and version control
- Integrating it with your existing documentation workflow
- Testing APIs
- Building a documentation team
- Managing an API documentation project
- Postman + SwaggerHub or Stoplight
- Open API 3.0
- Introduction to JIRA
- How to use JIRA as a ticketing tool.
- How to create sub-task
- JIRA workflow and reports
- JIRA dashboard tutorial
- Understanding the fundamentals
- Creating the repository
- Cloning the repository
- Adding new files
- Updating Git configuration
- Create branches and perform operations