oh-pdd-design-doc-generator_skill

Overview

This skill auto-generates HarmonyOS/OpenHarmony design documentation from a PRD, producing architecture and functional design documents that align with the existing OpenHarmony codebase. It analyzes the target code structure before generation to ensure compatibility and enforces that the architecture doc places competitor analysis as Chapter 2 immediately after requirements. Outputs include diagrams, code-path lists, and versioned Markdown files.

How this skill works

The tool parses the provided PRD and maps PRD sections to standard design chapters, then scans the OpenHarmony repository using glob/grep patterns to discover bundles, IDL, build scripts, and SA profiles. It synthesizes architecture_vX.md and functiondesign_vX.md using templates, injects code-derived module lists and dependency graphs, and validates chapter order rules (Requirement Background → Competitor Analysis → Harmony Architecture).

When to use it

• Generate full architecture and functional design docs from a PRD
• Generate only architecture design document while ensuring competitor analysis is included
• Produce functional specifications and interface definitions from PRD user stories
• Create HarmonyOS-compatible system architecture aligned with existing SA layout
• Analyze an OpenHarmony codebase to extract SA, interfaces, and dependencies

Best practices

• Provide a complete PRD with explicit requirement background and competitor section to improve output fidelity
• Point the tool at a representative OpenHarmony repo root so glob/grep can discover bundle.json, BUILD.gn, IDL and sa_profile files
• Review the generated competitor analysis (Chapter 2) and supply additional competitor references if deeper technical diagrams are needed
• Specify SA IDs, product name, and document version in the request to correctly populate headers and mappings
• Validate generated diagrams and deployment models against real runtime constraints before implementation

Example use cases

• Turn PRD v17 into architecture_v1.md and functiondesign_v1.md with code-path mapping and diagrams
• Produce an architecture doc that includes at least two competitor technical analyses and a technical comparison table
• Scan an existing OpenHarmony module tree to list SA IDs, subsystem organization, and interface candidates
• Generate state machine and sequence diagrams for key flows (e.g., formatDisk) using extracted IDL and service names
• Create output bundle including architecture, function design, code_paths, and diagram PNGs for handoff to engineering