| title | course | permalink | weight | sidebar | section | path1 | last-modified |
|---|---|---|---|---|---|---|---|
Overview of testing your docs |
Documenting REST APIs |
learnapidoc/testingdocs_overview.html |
6.1 |
docapis |
testingdocs |
learnapidoc/testingdocs.html |
2018-12-24 |
{% include coffeeshopbook.html %}
Up until now, you've been focused intensely on API documentation. In this section, I'll talk about an aspect of API documentation that is perhaps more applicable to all types of documentation but which is especially relevant to developer docs, where testing and experimenting with the products and services is not always straightforward.
Walking through all the steps in documentation yourself is critical to producing high-quality, accurate instructions. The more complex setup you have, the more difficult it can be to test all of the steps. Still, if you want to move beyond merely editing and publishing engineer-written documentation, you’ll need to build sample apps or set up the systems necessary to test the API docs. These tests should mirror what actual users will do as closely as possible.
- TOC {:toc}
{% include random_ad4.html %}
When you start setting up tests for your documentation, you typically interact with the quality assurance (QA) team. Developers might be helpful too, but the quality assurance team already has, presumably, a test system in place, usually a test server, and test cases. "Test cases" are the various scenarios that the product needs to be tested against.
{% include random_ad3.html %}
You'll want to make friends with the quality assurance team and find out best practices for testing scenarios relevant to your documentation. They can usually help you get started in an efficient way, and they'll be excited to have more eyes on the system. If you find bugs, you can either forward them to QA or log them yourself in the team's issue tracker.
{% include image_ad_right.html %}
If you can hook into a set of test cases that QA teams use to run tests, you can often get a jump start on the tasks you're documenting. Good test cases usually list the steps required to produce a result, and the scripts can inform the documentation you write.
{% include random_ad2.html %}
Testing your API doc content is so critical, I've created an entire section devoted to this topic. This section includes three topics:
Photo from Flickr, CC BY 2.0 — City water testing laboratory, 1948. When I think about testing docs, I like to think of myself as a scientist in a laboratory, carefully setting up tests to measure reactions and outcomes.
{% include ads.html %}