synthesize-tech-docs

What problem does it solve?

Engineering documentation for new features is often incomplete, misaligned with actual implementation, or missing critical context from product and design teams, leading to confusion, onboarding delays, and miscommunication between engineering, product, and design stakeholders.

Core Features & Use Cases

• Triple-source synthesis: Combines context from the Product Requirements Document (PRD, for business intent, scope, and success metrics), design doc (for UX flows and user intent), and actual production code (for ground truth on what was built) to create fully aligned documentation.
• Discrepancy surfacing: Explicitly flags mismatches between planned PRD/design intent and actual code implementation, so teams can address gaps before they cause downstream issues.
• Multiple output formats: Generates a README for engineer onboarding, an architecture/system overview for tech leads, and/or an API reference for cross-team integrators, saved as local markdown with optional Confluence publishing.
• Use Case: When your team launches a new feature and needs documentation that explains not just what the code does, but why it was built and how it aligns with user experience design, without gaps between planned requirements and actual implementation.

Quick Start

Use the synthesize-tech-docs skill to generate complete engineering documentation for your new feature by providing the PRD file, design doc, and local or GitHub codebase path.