1. I'd Rather Be Writing
2. Learn API Doc
3. Chapter 6: Testing API documentation

Chapter 6: Testing API documentation

Download PDF

Testing documentation against your APIs is critical for documentation quality. Fortunately, testing REST APIs and their responses tends involves less setup and expertise than testing library-based APIs like Java. Even so, to test your docs, you need to set up a test environment and get access to API keys or other resources. This will involve collaborating with QA teams. Your goal should be to walk through your instructions personally, making test calls and verifying the responses. You also should push back against any technical assumptions as you champion user needs. In short, testing docs means avoiding passively documenting what engineers say but rather actively validating as much as you can.

Sections:

• Overview of testing your docs
• Set up a test environment
• Test all instructions yourself
• Test your assumptions
• Activity: Test your project's documentation