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

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✅ 5. Show use cases

✅ 5. Show use cases

Number of APIs: 2

Provide examples GET https://api.coindesk.com/v1/bpi/historical/close.json?start=2013-09-01&end=2020-09-01
Demonstrate scenarios GET https://api.coindesk.com/v1/bpi/currentprice.json

Related Documentation

The Good Documentation ChecklistThe Good Documentation Checklist 3
✅ 1. Create a Qodex collection1 Create A Qodex Collection 2
✅ 1. Create a Qodex collectionGenerate from an API specification
✅ 1. Create a Qodex collectionFind a collection
✅ 1. Create a Qodex collectionStart from scratch

Add placeholder text

Provide examples

Developer ExperienceAPI Documentation

Claim this page Report this page All Projects

Powered byQodex.ai