Technical Writing: How to Write API Software Documentation
A framework for writing software documentation for an API as a technical writer, using Postman or Swagger UI
4.41 (1259 reviews)
14 599
students
3 hours
content
Jan 2023
last update
$64.99
regular price
What you will learn
What is API?
What is API documentation?
Which steps to follow to create API documentation?
How to use Swagger UI to write API documentation?
How to use Postman to check the functionality provided with an API
How to put your API documentation together in a GitHub wiki page!
Course Gallery
Charts
Students
Price
Rating & Reviews
Enrollment Distribution
Comidoc Review
Our Verdict
This 3-hour Technical Writing course on Udemy offers a thorough understanding of API documentation, using Postman, Swagger UI, and Github. While the instructor's accent may present challenges to some, thoughtful examples and real-world projects provide valuable experience in creating solid API documentation. Recommended for beginners seeking foundational knowledge and seasoned tech writers looking to expand their skill sets.
What We Liked
- Comprehensive coverage of API documentation process, from basics to hands-on practical experience
- Excellent pacing and clear explanations make it a great course for both beginners and experienced tech writers
- Real-world examples using Postman, Swagger UI, and Github provide essential understanding of API documentation tools
- Detailed walkthrough on creating a documentation draft in GitHub
Potential Drawbacks
- Accent can sometimes make content difficult to understand for non-native English speakers
- Lacks clarity for absolute beginners, suggesting searching for basic course first
- May require external resources or previous knowledge to fully grasp API concepts such as arrays, GET/SET/POST/DELETE
- Occasional dryness in presentation and overuse of slides can impact engagement
Related Topics
3753754
udemy ID
06/01/2021
course created date
16/07/2021
course indexed date
Bot
course submited by