Stage4 Flowchart Generation

Required

• sop_dir: Directory containing Stage 3 SOP files
  • Example: results/{company}/03_sop
  • Must contain .sop.md files

Optional

• output_dir (default: derived from sop_dir as {sop_dir}/../04_flowcharts): Directory to save flowchart files. Defaults to a sibling 04_flowcharts/ directory next to 03_sop/.

• mode (default: "standard"): Flowchart generation depth mode

  • "quick": Simple flowcharts (5-10 nodes), basic decision tree only
  • "standard": Balanced flowcharts (15-30 nodes), main process flows (default)
  • "deep": Detailed flowcharts (30+ nodes), full process with all edge cases

• target_sops (default: "all"): Which SOPs to generate flowcharts for

  • "all": Generate for all SOPs (both TS and HT)
  • "ts_only": Only Troubleshooting SOPs (recommended for complex processes)
  • "ht_only": Only How-To SOPs
  • List: ["TS_001", "HT_002"] - Specific SOP IDs

• output_format (default: "both"): Output file format

  • "markdown": Mermaid markdown only
  • "svg": SVG image only
  • "both": Both markdown and SVG (recommended)

• color_scheme (default: "status"): Color coding strategy

  • "status": Success (green), Warning (yellow), Error (red), Info (blue)
  • "priority": High/Medium/Low priority
  • "none": No color coding

Steps

1. Validate Inputs

Verify Stage 3 SOP files and Mermaid CLI installation.

Actions:

• Check sop_dir exists and contains .sop.md files
• Derive output_dir if not provided: {sop_dir}/../04_flowcharts (e.g., results/{company}/04_flowcharts)
• Create output directory: mkdir -p {output_dir}
• Verify Mermaid CLI is installed: mmdc --version
• If CLI not installed:
  • ⚠️ Warn user that SVG generation will be skipped
  • Automatically adjust output_format to "markdown" only
  • Continue with Mermaid markdown generation
• Count number of SOPs to process
• Filter by target_sops parameter

Expected Output (CLI installed):

✅ Stage 4 준비 완료
  - SOP 디렉토리: results/{company}/03_sop
  - 출력 디렉토리: results/{company}/04_flowcharts (생성됨)
  - 발견된 SOP: 7개 (TS: 4개, HT: 3개)
  - 처리 대상: 7개 (전체) 또는 4개 (TS만) 또는 3개 (HT만)
  - Mermaid CLI: 설치됨 (v11.12.0)
  - 출력 형식: Markdown + SVG

Expected Output (CLI not installed):

✅ Stage 4 준비 완료
  - SOP 디렉토리: results/{company}/03_sop
  - 출력 디렉토리: results/{company}/04_flowcharts (생성됨)
  - 발견된 SOP: 7개 (TS: 4개, HT: 3개)
  - 처리 대상: 7개 (전체) 또는 4개 (TS만) 또는 3개 (HT만)
  - Mermaid CLI: ❌ 미설치
  - 출력 형식: Markdown만 (SVG 생성 건너뜀)

⚠️ SVG 이미지가 필요하면 나중에 설치 후 변환 가능:
   npm install -g @mermaid-js/mermaid-cli
   mmdc -i TS_001_FLOWCHART.md -o TS_001_flowchart.svg -b transparent

2. Analyze SOP Structure

For each target SOP, analyze structure to extract flowchart components.

Actions:

• Read SOP file
• Identify SOP type (TS or HT)
  • TS (Troubleshooting): Focus on decision trees and problem resolution paths
  • HT (How-To): Focus on sequential steps and process flows
• Extract "케이스 1, 2, 3..." sections or step sequences
• Parse decision logic and branches
• Identify escalation criteria

Expected Duration: 1-2 minutes per SOP

3. Generate Mermaid Flowchart

Convert analyzed structure into Mermaid flowchart syntax.

You MUST read templates/FLOWCHART_template.md before generating any flowchart. This template defines the official color scheme (classDef), node shapes, naming conventions, and quality checklist.

Key rules from the template:

• Use classDef for color coding (NOT inline style per node):

  classDef successClass fill:#d4edda,stroke:#28a745,stroke-width:2px
  classDef warningClass fill:#fff3cd,stroke:#ffc107,stroke-width:2px
  classDef dangerClass  fill:#f8d7da,stroke:#dc3545,stroke-width:2px
  classDef infoClass    fill:#d1ecf1,stroke:#17a2b8,stroke-width:2px
  classDef processClass fill:#e7f3ff,stroke:#0056b3,stroke-width:2px
  classDef apiClass     fill:#fff0c0,stroke:#e6a817,stroke-width:2px,stroke-dasharray:5 5
  

• Apply classes with class NodeA,NodeB successClass at the end of the diagram
• Node shapes: ([...]) start/end, {...} decision, [...] process, [[...]] API call nodes
• API call nodes: Represent steps that actually call an external API as [[API Name<br>Return field check]] and apply apiClass (dashed yellow border)
• No double-quotes inside node labels — use <br/> for line breaks
• Keep node text ≤ 15 characters per line

Mode-Specific Behavior:

• Quick Mode: Simple (5-10 nodes), main paths only
• Standard Mode: Balanced (15-30 nodes), all standard cases (default)
• Deep Mode: Comprehensive (30+ nodes), all edge cases and escalation paths

Expected Duration:

• Quick: 1-2 minutes per SOP
• Standard: 2-3 minutes per SOP
• Deep: 3-5 minutes per SOP

4. Create Flowchart Markdown File

Write complete flowchart documentation following templates/FLOWCHART_template.md structure exactly. Save each flowchart file to {output_dir}/{SOP_ID}_FLOWCHART.md (NOT inside the sop_dir).

You MUST use this section order:

# [{SOP 파일명}] Flowchart

## 상담 흐름도

```mermaid
flowchart TD
    ...
    classDef successClass ...
    classDef warningClass ...
    classDef dangerClass  ...
    classDef infoClass    ...
    classDef processClass ...
    class ... successClass
    class ... warningClass
    ...

케이스별 설명

🟢 정상 처리 (초록색)

• 케이스 N: {설명} — 자동화 가능: {X}% ({해결 기술: RAG/Action/Rules})

🟡 주의 필요 / 조건부 처리 (노란색)

• {설명}

🔴 담당팀 전달 / 에스컬레이션 (빨간색)

• {설명}

🔵 의사결정 포인트 (파란색)

• {설명}

⚙️ 정보 확인 단계 (연한 파란색)

• {설명}

주요 체크포인트

담당팀 전달 기준 ← TS SOP에만 포함

생성 정보:

• 원본 SOP: {파일명}.sop.md
• 생성일: {YYYY-MM-DD}
• 플로우차트 버전: v1.0
• 데이터: {N}건 ({%}%)

**Automation info MUST be included in each case description:**
- Each case MUST include **Automatable**: X% and the technique used (RAG/Action/Rules)
- This data is used as the basis for ALF participation/resolution rate calculation in Stage 5

**Expected Duration:** 1-2 minutes per SOP

### 5. Convert to SVG Image (CLI Required)

Use Mermaid CLI to generate SVG images if installed.

**Actions:**
- Check if Mermaid CLI is installed
- **If installed:**
  ```bash
  mmdc -i {output_dir}/{SOP_ID}_FLOWCHART.md -o {output_dir}/{SOP_ID}_flowchart.svg -b transparent

• If not installed:
  • Skip SVG generation
  • Note in summary that markdown files can be viewed in VSCode or GitHub

Expected Duration: 10-20 seconds per SOP (if CLI installed)

Troubleshooting:

• Parse error: Remove quotes and emoticons from node text
• Retry: Re-run mmdc command
• CLI not found: Skip SVG, continue with markdown only

6. Generate Summary Report

Create summary of flowchart generation results.

Actions:

• Count generated files
• List all flowcharts with file sizes
• Provide viewing instructions
• Save to flowchart_generation_summary.md

7. Update Metadata

Update metadata.json with flowchart references.

Actions:

• Add flowchart info to each SOP entry
• Save updated metadata

Examples

Example 1: Full Run (All SOPs)

Input:

sop_dir: results/{company}/03_sop
target_sops: all
output_format: both

Output:

• 7 Markdown files in 04_flowcharts/ (TS_001004_FLOWCHART.md, HT_001003_FLOWCHART.md)
• 7 SVG images (~170KB each) in 04_flowcharts/
• 1 Summary report
• Updated metadata.json

Time: ~4-5 minutes

Example 2: TS Only Run

Input:

sop_dir: results/{company}/03_sop
target_sops: ts_only
output_format: both

Output:

• 4 Markdown files (TS_001~004_FLOWCHART.md)
• 4 SVG images (~170KB each)
• 1 Summary report
• Updated metadata.json

Time: ~3-4 minutes

Example 3: Specific SOPs

Input:

sop_dir: results/{company}/03_sop
target_sops: ["TS_001", "HT_001"]

Output:

• 2 Flowcharts (1 TS, 1 HT)
• 2 SVG images

Time: ~2 minutes

Example 4: Markdown Only (CLI 없음)

Input:

sop_dir: results/{company}/03_sop
target_sops: all

Detected: Mermaid CLI not installed

Output:

• 7 Markdown files only (TS_001004_FLOWCHART.md, HT_001003_FLOWCHART.md)
• ⚠️ SVG 생성 건너뜀
• 1 Summary report

Time: ~3-4 minutes (SVG 변환 시간 제외)

Note: Markdown 파일은 VSCode Mermaid 확장 또는 GitHub에서 바로 렌더링됨

Viewing Flowcharts

VSCode에서 SVG 보기

1. SVG 파일 클릭 → 자동 렌더링

Markdown 프리뷰 (확장 필요)

1. 확장 설치: "Markdown Preview Mermaid Support"
2. Cmd + Shift + V

브라우저

• SVG 파일을 브라우저로 드래그

Related Documentation

• Flowchart Template ⭐: FLOWCHART_template.md — MUST use this template as the basis for all flowchart generation
• Stage 3 SOP Generation: stage3-sop-generation.sop.md
• Full Pipeline: userchat-to-sop-pipeline.sop.md
• Mermaid Documentation: https://mermaid.js.org/

Notes

When to Use Stage 4

Recommended situations:

• Complex Troubleshooting SOPs (5+ cases, many decision branches)
• Multi-step How-To SOPs (need to visualize sequential processes)
• Onboarding materials for new staff
• Process review and optimization
• Customer presentations

Can be skipped when:

• Very simple SOPs (3 steps or fewer)
• Text-based SOP is sufficient
• Time constraints

TS vs HT flowchart characteristics:

• TS: Emphasizes decision trees, conditional branches, escalation paths
• HT: Emphasizes sequential steps, checkpoints, parallel task flows

Flowchart Quality Criteria

Good Flowchart:

• ✅ Entire process visible on one screen
• ✅ Cases clearly distinguished by color
• ✅ Decision points are clear
• ✅ Escalation paths are shown

Bad Flowchart:

• ❌ Too many nodes (50+)
• ❌ Too many crossing arrows
• ❌ Node text too long
• ❌ Monochrome with no color coding

This is an optional Stage 4. Use when visual process documentation adds value beyond text-based SOP.