hld-writer

To generate high-level design documentation from a PRD and API contracts, provide the document paths and target functional requirement ID to map architecture decisions, component boundaries, and API integration points into a structured HLD.

End-to-end mapping in an HLD translates PRD requirements into structured architecture, data design, and API reference sections, ensuring API contracts are cited and traceability is maintained across all documentation.

Maintain PRD traceability and enforce API contract references by generating high-level designs that map target functional requirements directly to architecture decisions and component boundaries, ensuring downstream design work remains aligned.

Yes, you can use Mermaid to visualize component boundaries and architecture decisions within your HLD, as the generated high-level design documentation supports structured diagrams for clear, decision-focused technical communication.

The best way to structure an HLD for downstream LLD work is to enforce end-to-end mapping from PRD requirements across architecture, data design, and API references, ensuring clear, decision-focused documentation ready for detailed implementation.

Yes, you need a complete PRD and API contract before writing architecture documentation, because the HLD generation process relies on mapping specific functional requirements and citing API contracts to establish component boundaries and traceability.