Comidoc Analysis
API Documentation 2: Teaches technical writers how to document REST. No programming experience required.
Learn API Technical Writing 2: REST for Writers
InstructorPeter GruenbaumDuration1h 45m
Students14.5K
Rating4.5 (3,673)
API Documentation 2: Teaches technical writers how to document REST. No programming experience required.
InstructorPeter GruenbaumEditorial course preview
These 3 complementary views highlight concrete, legible examples from the course presentation.
This instructional slide outlines a hands-on exercise for documenting query parameters, listing specific fields such as startDate and status with their formats.
This course overview slide outlines the key technical components of REST APIs covered in the curriculum, including requests, resources, HTTP methods, query parameters, headers, authentication, and responses.
This chart illustrates the rapid growth of web APIs from 2005 to 2013, highlighting the expanding market demand for technical documentation skills.
The structure moves logically through technical components including resources, methods, query parameters, and headers.
The curriculum includes multiple practical exercises focused on documenting method URLs, query parameters, and headers.
Instruction is delivered in manageable parts that avoid the curse of knowledge, making it suitable for beginners.
One signal indicates that the specific documentation tools covered may be outdated compared to current industry standards.
The curriculum aligns well with the goal of transitioning technical writers into API documentation.