doc-quality-checklist.md

Documentation Quality Checklist

Use this checklist before submitting a tutorial update or new tutorial.

Learning Quality

• Explains how the system works, not only how to use it
• Covers design tradeoffs and architecture decisions
• Uses production-oriented examples instead of toy-only snippets
• Includes clear prerequisites and expected reader level

Content Completeness

• Tutorial has a clear structure and logical progression
• Index page links are valid and navigable
• Setup instructions are complete and reproducible
• Troubleshooting guidance is included where appropriate

Accuracy and Currency

• Commands and API examples are still valid
• Version-sensitive notes are included when needed
• Claims are verifiable from project source/docs
• Outdated or speculative sections are marked clearly

Formatting and Accessibility

• Headings are consistent and scannable
• Tables and diagrams render correctly
• Links are working and point to the intended targets
• Markdown is readable on desktop and mobile
• If using format_version: v2, index follows formats/pocketflow-index-style.md

Repository Standards

• Entry follows templates/tutorial-template.md
• Tutorial indexes use templates/tutorial-index-template-v2.md when applicable
• Category placement is correct
• Related docs (README.md, CONTRIBUTING.md, templates) are updated when needed