Design Document Generator

Quick Start

Generate design documents based on {PRD Document}

Generate architecture design document and functional design document based on {PRD Document Path}

OpenHarmony Code Analysis

Analysis Steps

1. Discover Code Structure

**/bundle.json

**/BUILD.gn

**/config.json

**/README.md

**/*.md

**/*.idl

**/include/*.h

**/*.gn

**/*.gni

**/sa_profile/*.json

**/etc/profile/*.json

2. Search for Key Information

"sa-id"

subsystem_name

external_deps

interface

class.*Service

.*Provider

3. Read Key Configurations

• bundle.json

  : Component definition and subsystem affiliation

• BUILD.gn

  : Build dependencies and compilation options

• sa_profile/*.json

  : SA configuration and startup parameters

• README.md

  : Module description and usage guide

• *.idl

  : Interface definitions and data structures

4. Intelligent Exploration

• Discover directory structure of related modules
• Find implementation references for similar functions
• Extract interface design and data structures

Naming Pattern Inference

*_service.cpp

disk_info_service.cpp

*_provider.h/cpp

disk_manager_provider.cpp

*_listener.idl

IDiskChangeListener.idl

*_types.idl

DiskInfoTypes.idl

*/kits/

kits/js/

kits/native/

*/innerkits/

innerkits/native/

*/sa_profile/

sa_profile/5001.json

*/test/

test/unittest/

*/mock/

test/mock/

Analysis Output

1. Existing SA List: Assigned SA IDs and service names
2. Subsystem Organization: Hierarchy of subsystems and components
3. Dependency Graph: Dependencies between components
4. Interface Reference: Interface design references for similar functions
5. Code Style Reference: Naming conventions, directory structure, etc.

Competitor Solution Analysis Chapter Requirements

Chapter Structure

2. Competitor Solution Analysis

2.1 Competitor Identification

• List main competitors (at least 2-3)
• Explain reasons for competitor selection
• Competitor types: similar products, technical solutions, industry standards

2.2 Competitor Technical Solution Analysis

• Core technical architecture
• Key technical components
• Communication mechanism
• Data flow
• Key flowcharts, sequence diagrams

2.3 Technical Comparison Table

2.4 Differentiated Design

• Innovations of our solution compared to competitors
• Pain points of competitors solved by our solution
• Technical advantage explanation
• Reference and improvement

Output Requirements

• Present competitor technical solutions using 4+1 view, flowcharts, sequence diagrams
• Include detailed analysis of at least 2 competitors
• Must have a technical comparison table
• Must clarify differentiated design points

Chapter Order Verification

Standard order: Requirement Background → Competitor Solution Analysis → HarmonyOS Architecture Analysis → Architecture Design...

• ✅ Chapter 1 must be "Requirement Background"
• ✅ Chapter 2 must be "Competitor Solution Analysis" (Required)
• ✅ Competitor Solution Analysis must be after Requirement Background
• ✅ Competitor Solution Analysis must be before Architecture Design
• ❌ If the order is wrong, prompt the user to adjust

1. Extract all level 1 headings (starting with #)
2. Verify if Chapter 1 is "Requirement Background"
3. Verify if Chapter 2 is "Competitor Solution Analysis" or "Competitor Analysis"
4. If Chapter 2 is missing or the order is wrong, return an error prompt

Generated Content

Architecture Design Document (architecture_vX.md)

Functional Design Document (functiondesign_vX.md)

Architecture Layers

┌─────────────────────────────────────────┐
│              Application Layer         │
│         Settings App | File Manager | Disk Tool      │
└─────────────────────────────────────────┘
                    ↓ NAPI/IPC
┌─────────────────────────────────────────┐
│               Service Layer            │
│      DiskManagement SA (5001)            │
│  DiskInfo | Format | Repair | Status     │
└─────────────────────────────────────────┘
                    ↓
┌─────────────────────────────────────────┐
│               Tools Layer              │
│    FormatTool | FsckTool | PartedTool    │
└─────────────────────────────────────────┘
                    ↓
┌─────────────────────────────────────────┐
│              System Layer              │
│  Storage SA | OsAccount SA | HiSysEvent   │
└─────────────────────────────────────────┘

SA Division Rules

State Machine Design

stateDiagram-v2
    [*] --> UNKNOWN
    UNKNOWN --> NORMAL: Detection successful
    UNKNOWN --> ABNORMAL: Detection failed
    NORMAL --> CHECKING: Start detection
    CHECKING --> NORMAL: Detection completed
    CHECKING --> REPAIRING: Need repair
    CHECKING --> ABNORMAL: Detection failed
    REPAIRING --> NORMAL: Repair successful
    REPAIRING --> ABNORMAL: Repair failed
    ABNORMAL --> CHECKING: Retest

Sequence Diagram Example

sequenceDiagram
    participant App as Application
    participant Kit as DiskManagementKit
    participant SA as DiskManagement SA
    participant Tool as FormatTool

    App->>Kit: formatDisk(diskId, fsType)
    Kit->>SA: format(diskId, fsType)
    SA->>SA: Permission verification
    SA->>SA: State verification
    SA->>Tool: executeFormat()
    Tool-->>SA: onProgress(percent)
    SA-->>Kit: onFormatProgress()
    Kit-->>App: progress callback
    Tool-->>SA: result
    SA-->>Kit: result
    Kit-->>App: format result

Reference Documents

• Architecture Design Template: references/architecture_template.md
• Functional Design Template: references/functional_template.md
• State Machine Specification: references/state_machine_spec.md
• Interface Design Guide: references/interface_guide.md

Mapping with PRD

Dependent Service Mapping

Output Directory Structure

output/
├── architecture_v1.md      # Architecture design document
├── functiondesign_v1.md     # Functional design document
├── code_paths_v1.md        # Code path document
└── diagrams/               # Generated diagram files
    ├── architecture.png
    ├── state_machine.png
    └── sequence.png

Usage Examples

Generate architecture and functional design documents based on {PRD Document}

Generate only architecture design document based on {PRD Document}

Generate design documents using {SA_ID} as SA ID, based on {PRD Document}

Generate design documents for {Product Name} {Version}, document version {Document Version}, based on {PRD Document}

Generate design documents to ./design_docs directory, based on {PRD Document}

Naming Conventions

architecture_v{major}.md

functiondesign_v{major}.md

code_paths_v{major}.md

prd_v{version}.md

Version Management Rules

Chart Format

• Flowchart:

  graph TD

  or

  flowchart TD

• State Diagram:

  stateDiagram-v2

• Sequence Diagram:

  sequenceDiagram

• Class Diagram:

  classDiagram

• Component Diagram:

  graph LR

Error Handling