PRE DOC CHECKLIST

Pre-documentation checklist

Run through this checklist before writing docs for a new release.

1. Feature validation

• Confirm feature is shipping (not still in backlog)
• Check if feature is NEW or ENHANCEMENT to existing feature
• Identify the correct version (5.x.0) for the feature

2. Overlap check

• Search existing docs for related content: grep -r "feature name" 5.1/
• Check if a standalone doc is needed or if existing doc should be updated
• Review release notes from when related features shipped

3. Source gathering

• Jira: Export fixed version tickets
• Notion: Search for epic/feature specs
• Slack: Check #tech-docs, #tech-platform for discussions
• GitHub: Find relevant PRs with gh pr list --search "feature name"

4. Specs file

• Copy TEMPLATE.md to specs/v5.x.0.md
• Use Claude web to fill in specs from Notion/Slack
• Mark gaps with ⚠️ Documentation Gap:
• Save specs file before starting docs

5. Navigation planning

• Decide where new docs go in docs.json
• Check if new navigation group needed
• Identify related docs to link to

6. After writing

• Run link validation
• Check docs.json is updated
• Review for terminology consistency
• Delete or archive specs file after release