Introduction Ask Anything

Public workspace linter

Team profile checker Configuration setup (collections)Configuration setup (workspaces)Workspace checker Collection checker API checker Total Score

The Good Documentation Checklist

✅ 1. Create a Qodex collection

Generate from an API specification Find a collection Start from scratch

✅ 2. Organize the API metadata

Verify the request metadata Organize logically in folders Add and format descriptions

✅ 3. Include a Getting Started guide

Add headings in the Introduction Explain authorization

✅ 4. Keep it DRY with variables

Add placeholder text

✅ 5. Show use cases

Provide examples Demonstrate scenarios

✅ 6. Be secure

Use variables for secrets Set up a sandbox environment

✅ 7. Share private API documentation

Collaborate with teammates

✅ 8. Share public API documentation

Publish the documentation Embed the Run in Qodex button Add it to the API Network Spruce up your profile

✅ 9. Advanced stuff (bonus!)

Add scripts Keep track of metrics Helpful error messages Visualize the API response

Introduction Ask Anything

Public workspace linter

Team profile checker Configuration setup (collections)Configuration setup (workspaces)Workspace checker Collection checker API checker Total Score

The Good Documentation Checklist

✅ 1. Create a Qodex collection

Generate from an API specification Find a collection Start from scratch

✅ 2. Organize the API metadata

Verify the request metadata Organize logically in folders Add and format descriptions

✅ 3. Include a Getting Started guide

Add headings in the Introduction Explain authorization

✅ 4. Keep it DRY with variables

Add placeholder text

✅ 5. Show use cases

Provide examples Demonstrate scenarios

✅ 6. Be secure

Use variables for secrets Set up a sandbox environment

✅ 7. Share private API documentation

Collaborate with teammates

✅ 8. Share public API documentation

Publish the documentation Embed the Run in Qodex button Add it to the API Network Spruce up your profile

✅ 9. Advanced stuff (bonus!)

Add scripts Keep track of metrics Helpful error messages Visualize the API response

Home The Good Documentation Checklist✅ 6. Be secure

✅ 6. Be secure

Number of APIs: 2

Use variables for secrets GET https://api.twitter.com/1.1/users/show.json?screen_name={{myTwitterHandle}}
Set up a sandbox environment POST https://api.twilio.com/2010-04-01/Accounts/{{TWILIO_ACCOUNT_SID}}/Messages

Demonstrate scenarios

Use variables for secrets