Omnichannel Retail Integration Docs Audit Report

Role: Principal Technical Writer and Retail Systems Architect with 15+ years evaluating enterprise commerce developer documentation.

Context

• Retail brand: {{retail_brand_name}}
• Core POS architecture: {{pos_architecture_type}}
• Evaluated API & webhook endpoints: {{integration_endpoints}}
• Target reader profile: {{target_developer_persona}}
• Baseline documentation issues: {{known_documentation_gaps}}
• Retail compliance frameworks: {{compliance_standards}}

Task

Produce an exhaustive technical documentation audit report that assesses the developer usability, architectural completeness, error-handling transparency, and integration safety for {{retail_brand_name}}'s omnichannel endpoints.

Method

1. Analyze {{pos_architecture_type}} data flows against the documented {{integration_endpoints}} to identify unmapped state transitions.
2. Cross-reference payload schemas against {{target_developer_persona}} workflow expectations to evaluate onboarding friction.
3. Audit authentication, idempotency keys, rate limits, and webhook retry mechanisms across all endpoint guides.
4. Map reported issues in {{known_documentation_gaps}} to specific technical chapters and code snippet samples.
5. Benchmark the documentation suite against mandatory {{compliance_standards}} for retail transaction logging.
6. Structure actionable revision matrices with severity ratings, code sample remediation, and schema validation benchmarks.
7. Formulate a phased release roadmap for engineering docs, SDK reference guides, and interactive sandboxes.

Constraints

• MUST evaluate every endpoint listed in {{integration_endpoints}} with concrete technical audit criteria.
• MUST include explicit remediation code block specifications rather than generic writing advice.
• MUST NOT suggest deprecating endpoints without documenting fallbacks and backward compatibility.
• Exclude consumer-facing marketing language; maintain rigorous technical documentation standards.

Output format

Generate a structured markdown report containing:

1. Executive Technical Summary (under 250 words)
2. Endpoint & Schema Usability Matrix (table covering endpoint, issue type, developer friction rating, and required fix)
3. Compliance & Edge Case Gaps (detailed technical analysis covering {{compliance_standards}})
4. Code Sample & API Reference Remediation Plan (at least 3 before/after snippet definitions)
5. Phased Documentation Roadmap (Quarterly milestones with effort estimation)

Self-review

• Ensure every endpoint from {{integration_endpoints}} is addressed in the matrix.
• Verify that code remediation examples adhere strictly to {{compliance_standards}}.
• Confirm all 6 method steps have direct representation in the output sections.