Activity: Test the docs in your Open Source project

Now that you’ve read about testing, it’s time to get some more hands-on practice.

1. Test a topic

With the open-source API project you’re working with, find one of the following:

  • Getting started tutorial
  • An API endpoint
  • A tutorial or other key task

Test the content. Run all the endpoint requests. Proceed through all the steps in the tutorial. Do all the identified tasks with the topic. As you test out the content, identify any incorrect or missing or inaccurate information.

2. Find out test details

Identify who performs the testing on the project. Reach out and interact with the QA lead for the project to gather as much information as you can about how testing is done. Find answers to the following questions:

  • Are there test cases used to run through various scenarios in the project?
  • Where are the test cases stored?
  • How are the tests executed? Automatically? Manually?
  • What kind of testing is done before a release?
  • If you encounter a bug while testing, how should you report it?
34% Complete

34/94 pages complete. Only 60 more pages to go...


If you would like to contribute back to say thank you for the API documentation course, click the Donate button below. Alternatively, to contribute content, such as a tutorial or a new section, contact me with your ideas. You can also submit a pull request in the GitHub repo to make your contribution. Even if you want to just fix a typo or add a sentence here and there, it's always welcome.

Get new posts delivered straight to your inbox.

Subscriber count: 4,285