Qodex.ai
Qodex.ai
IntroductionAsk Anything
Public workspace linter
Team profile checkerConfiguration setup (collections)Configuration setup (workspaces)Workspace checkerCollection checkerAPI checkerTotal Score
The Good Documentation Checklist
✅ 1. Create a Qodex collection
Generate from an API specificationFind a collectionStart from scratch
✅ 2. Organize the API metadata
Verify the request metadataOrganize logically in foldersAdd and format descriptions
✅ 3. Include a Getting Started guide
Add headings in the IntroductionExplain authorization
✅ 4. Keep it DRY with variables
Add placeholder text
✅ 5. Show use cases
Provide examplesDemonstrate scenarios
✅ 6. Be secure
Use variables for secretsSet up a sandbox environment
✅ 7. Share private API documentation
Collaborate with teammates
✅ 8. Share public API documentation
Publish the documentationEmbed the Run in Qodex buttonAdd it to the API NetworkSpruce up your profile
✅ 9. Advanced stuff (bonus!)
Add scriptsKeep track of metricsHelpful error messagesVisualize the API response
IntroductionAsk Anything
Public workspace linter
Team profile checkerConfiguration setup (collections)Configuration setup (workspaces)Workspace checkerCollection checkerAPI checkerTotal Score
The Good Documentation Checklist
✅ 1. Create a Qodex collection
Generate from an API specificationFind a collectionStart from scratch
✅ 2. Organize the API metadata
Verify the request metadataOrganize logically in foldersAdd and format descriptions
✅ 3. Include a Getting Started guide
Add headings in the IntroductionExplain authorization
✅ 4. Keep it DRY with variables
Add placeholder text
✅ 5. Show use cases
Provide examplesDemonstrate scenarios
✅ 6. Be secure
Use variables for secretsSet up a sandbox environment
✅ 7. Share private API documentation
Collaborate with teammates
✅ 8. Share public API documentation
Publish the documentationEmbed the Run in Qodex buttonAdd it to the API NetworkSpruce up your profile
✅ 9. Advanced stuff (bonus!)
Add scriptsKeep track of metricsHelpful error messagesVisualize the API response
HomeThe Good Documentation Checklist✅ 2. Organize the API metadataVerify the request metadata

Verify the request metadata

GET https://graph.microsoft.com/beta/applications

If you previously used a machine-readable data format, consider renaming your requests to be more human-readable. Verify the API metadata (e.g. method, URL, headers) displays in the way you want.

Microsoft example

This example is from Microsoft Graph's API Documentation.

Previous
✅ 2. Organize the API metadata
Next
Organize logically in folders