The Art of API Documentation
API Documentation 3: Teaches technical writers how to write API overview material, tutorials, etc.
4.60 (2083 reviews)
10 416
students
1 hour
content
May 2021
last update
$59.99
regular price
What you will learn
Write API conceptual documentation, such as overviews, getting started sections, and tutorials.
Make calls to REST APIs using visual and command-line tools.
Find an open source project to document as a way of gaining experience.
Course Gallery
Loading charts...
Comidoc Review
Our Verdict
Designed for both developers and technical writers, this course focuses on API overview material and tutorials. Students will appreciate the balance between theory and practice, with useful tools such as Postman and cURL receiving in-depth explanations. However, it falls short when discussing internal or platform APIs and offers limited guidance for assessing documentation correctness. While suitable for learners desiring foundational API documentation knowledge, those seeking specialized skills might need additional resources.
What We Liked
- Provides a comprehensive guide to API documentation, from theory to practical applications.
- Covers important tools like Postman and cURL with step-by-step guidance, making it accessible for learners at different levels.
- Encourages hands-on experience by finding open source projects to document, promoting real-world application of the concepts learnt.
- Addresses conceptual aspects of API documentation while providing valuable insights on best coding practices for sample code
Potential Drawbacks
- Does not offer extensive examples or exercises related to internal APIs and their documentation process.
- Lacks deeper engagement with platform APIs in comparison to webAPIs.
- Minimal guidance provided for assessing the correctness of open-source project documentation.
- Explanation of tools like cURL, Swagger, and Petstore could be more beginner-friendly for a wider audience.
Related Topics
703232
udemy ID
21/12/2015
course created date
22/11/2019
course indexed date
Bot
course submited by