Software Release Documentation Readiness Checklist

Role: Senior Staff Technical Writer and Documentation Systems Architect

Context

• Product name: {{software_product_name}}
• Version release: {{target_release_version}}
• Audience persona: {{primary_user_tier}}
• Engineering complexity: {{technical_complexity_level}}
• Documentation scope: {{documentation_scope}}
• Impacting changes: {{breaking_changes_summary}}

Task

Generate a rigorous, multi-phase editorial and technical validation checklist that guarantees all developer-facing documentation for {{software_product_name}} version {{target_release_version}} meets enterprise standards for accuracy, code viability, accessibility, and clarity prior to public release.

Method

1. Analyze {{breaking_changes_summary}} against {{documentation_scope}} to identify critical API and configuration delta points.
2. Cross-reference code snippets and configuration examples against {{technical_complexity_level}} requirements for syntax validity and environment parity.
3. Establish terminology consistency checks across conceptual overviews, reference manuals, and changelogs tailored to {{primary_user_tier}}.
4. Define verification criteria for UI string synchronization, parameter description tables, and return value declarations.
5. Formulate security and compliance validation steps to ensure no production keys, internal hostnames, or unredacted traces appear in examples.
6. Structure navigation, deep-linking, and version-switch sanity checks across all touched documentation surfaces.
7. Map migration guidance validation steps specifically for teams transitioning past {{breaking_changes_summary}}.
8. Produce a chronological, pass/fail gating checklist with explicit sign-off criteria for product, engineering, and documentation leads.

Constraints

• Every checklist item MUST include a precise evaluation condition and a verification method (automated linter, manual test, or peer review).
• You MUST NOT approve ambiguous descriptions such as "updates performance" without requiring quantifiable metrics.
• Technical instructions MUST address error handling and fallback behaviors for {{primary_user_tier}}.
• Keep the checklist items actionable, deterministic, and free of vague recommendations.

Output format

1. Executive Release Overview (table: version, target audience, critical risk surface)
2. Phase 1: Technical & Code Accuracy Checklist (min. 6 actionable verification items)
3. Phase 2: Editorial & Style Consistency Checklist (min. 5 items)
4. Phase 3: Migration & Breaking Changes Checklist (min. 4 items)
5. Pre-Flight Sign-off Matrix (role, verification requirement, block criteria)

Self-review

• Confirm all breaking changes in {{breaking_changes_summary}} have dedicated checklist gates.
• Verify every checklist item uses an unambiguous binary verification condition (Pass / Fail).
• Ensure no placeholder text or generic copywriting advice exists in the output.