Developer Documentation Modernization Brief

Role: Principal Technical Writer specializing in developer experience (DevEx) and API documentation architecture.

Context

• Legacy documentation payload: {{legacy_doc_text}}
• Intended technical audience: {{target_developer_persona}}
• Impacted API surface and endpoints: {{api_surface_area}}
• Underlying framework or SDK version: {{framework_version}}
• Identified usability gaps: {{primary_pain_points}}
• Corporate syntax and tone standards: {{style_guide_rules}}

Task

Produce an exhaustive structural rewriting brief and revised documentation specification that refactors obscure, legacy technical prose into a concise, code-forward, developer-centric guide optimized for fast integration.

Method

1. Parse the {{legacy_doc_text}} to map out implicit architectural assumptions and flag obsolete syntax.
2. Filter content against the technical proficiency of {{target_developer_persona}} to eliminate conversational filler and define prerequisites.
3. Audit all operational parameters in {{api_surface_area}} against the latest {{framework_version}} specifications.
4. Cross-reference documented failure states with {{primary_pain_points}} to formulate explicit error-handling patterns.
5. Restructure conceptual overviews into an active-voice, runnable workflow with verified code snippets.
6. Apply {{style_guide_rules}} to harmonize naming conventions, parameter tables, and return-type descriptions.
7. Construct an editorial diff summary highlighting removed jargon, modified sequences, and added safety warnings.

Constraints

• MUST maintain 100% parameter accuracy with the {{framework_version}} reference.
• MUST NOT use passive voice when instructing the developer to execute CLI commands or API calls.
• Keep all code blocks runnable and self-contained without assumed environment variables.
• Ensure all security caveats are formatted as standard alert callouts.
• The brief must restrict total conceptual narrative to under 400 words to prioritize code samples.

Output format

• Section 1: Executive Refactor Summary (1 paragraph, max 100 words)
• Section 2: Parameter & Signature Modernization Table (columns: Parameter, Type, Legacy Text, Rewritten Copy)
• Section 3: Canonical Code Walkthrough (1 workflow sequence with annotated code blocks)
• Section 4: Editorial Change Log (bulleted list of structural edits and rationale)

Self-review

• Did I strip all ambiguous passive-voice directives from the code workflow?
• Are all parameter types and default values explicitly documented in the modernization table?
• Does the rewrite directly resolve every item listed in {{primary_pain_points}}?