سیستم مستندات یکپارچه

Documentation - Business Flows

جریان‌های بیزینسی اصلی

  1. کاربر وارد index.html می‌شود
  2. guard نبود token را تشخیص می‌دهد و کاربر را به login می‌فرستد
  3. کاربر با ورود محلی token می‌گیرد و به صفحه مقصد برمی‌گردد
  4. داشبورد پروژه‌ها و شاخص‌ها را نمایش می‌دهد
  5. کاربر از navigation یا جستجو وارد صفحات پروژه می‌شود
  6. Mermaid diagramها رندر می‌شوند و در modal قابل مشاهده هستند
  7. در صورت تغییر کد، generator کل خروجی را بازتولید می‌کند

دیاگرام‌های بیزینسی

این دیاگرام‌ها از README/HANDOFF/PRD/docs و نام ماژول‌ها و endpointهای موجود ساخته شده‌اند. جاهایی که BPMN واقعی لازم است، خروجی به صورت BPMN-like در Mermaid flowchart تولید شده است.

Use Case Diagram

Mermaid flowchart - actor/use-case view

flowchart LR
  system(["System boundary: Documentation"])
  A1(["توسعه‌دهنده"])
  A2(["معمار نرم‌افزار"])
  A3(["QA"])
  A4(["DevOps"])
  A5(["مدیر محصول"])
  A6(["کاربر فنی"])
  UC1(("ورود به مستندات"))
  system --- UC1
  A1 --> UC1
  UC2(("جستجوی سراسری پروژه‌ها"))
  system --- UC2
  A2 --> UC2
  UC3(("مرور صفحات پروژه و shared catalog"))
  system --- UC3
  A3 --> UC3
  UC4(("مشاهده Mermaid diagramها در modal تمام صفحه"))
  system --- UC4
  A4 --> UC4
  UC5(("Regenerate مستندات از generator"))
  system --- UC5
  A5 --> UC5
  UC6(("بررسی manifest و search index"))
  system --- UC6
  A6 --> UC6
  classDef actor fill:#dbeafe,stroke:#2563eb,color:#0f172a
  classDef usecase fill:#f8fafc,stroke:#64748b,color:#0f172a

User Flow

Mermaid flowchart - end-to-end business flow

flowchart TD
  S1["کاربر وارد index.html می‌شود"]
  S2["guard نبود token را تشخیص می‌دهد و کاربر را به login می‌فرستد"]
  S1 --> S2
  S3["کاربر با ورود محلی token می‌گیرد و به صفحه مقصد برمی‌گردد"]
  S2 --> S3
  S4["داشبورد پروژه‌ها و شاخص‌ها را نمایش می‌دهد"]
  S3 --> S4
  S5["کاربر از navigation یا جستجو وارد صفحات پروژه می‌شود"]
  S4 --> S5
  S6["Mermaid diagramها رندر می‌شوند و در modal قابل مشاهده هستند"]
  S5 --> S6
  S7["در صورت تغییر کد، generator کل خروجی را بازتولید می‌کند"]
  S6 --> S7
  classDef start fill:#dcfce7,stroke:#16a34a,color:#0f172a
  classDef normal fill:#ffffff,stroke:#2563eb,color:#0f172a
  class S1 start
  class S2 normal
  class S3 normal
  class S4 normal
  class S5 normal
  class S6 normal
  class S7 normal

Sequence Diagram

Mermaid sequence diagram

sequenceDiagram
  autonumber
  participant User as User
  participant login_html as login.html
  participant auth_js as auth.js
  participant index_html as index.html
  participant search_js as search.js
  participant diagrams_js as diagrams.js
  participant generate_docs_py as generate-docs.py
  User->>index_html: باز کردن مستندات
  index_html->>auth_js: بررسی localStorage token
  auth_js->>login_html: redirect در صورت نبود token
  login_html->>auth_js: ثبت token محلی
  auth_js->>index_html: بازگشت به next page
  index_html->>search_js: فعال‌سازی search-index
  index_html->>diagrams_js: رندر Mermaid و modal تمام صفحه

Business Block Diagram

Mermaid block diagram

block-beta
  columns 3
  B1["index.html"]
  B2["login.html"]
  B3["auth.js"]
  B4["search.js"]
  B5["diagrams.js"]
  B6["app.css"]
  B7["docs-manifest.json"]
  B8["search-index.json"]
  B9["generator"]

BPMN-like Process

Mermaid flowchart with swimlane-style subgraphs

flowchart LR
  subgraph L1["کاربر"]
    L1S1["باز کردن مستندات"]
    L1S2["ورود"]
    L1S1 --> L1S2
    L1S3["جستجو و مرور"]
    L1S2 --> L1S3
  end
  subgraph L2["Frontend Static App"]
    L2S1["Guard token"]
    L2S2["Render pages"]
    L2S1 --> L2S2
    L2S3["Render diagrams"]
    L2S2 --> L2S3
  end
  L1S3 --> L2S1
  subgraph L3["Generator"]
    L3S1["Scan projects"]
    L3S2["Build HTML/JSON/assets"]
    L3S1 --> L3S2
    L3S3["Write manifest/search index"]
    L3S2 --> L3S3
  end
  L2S3 --> L3S1
  classDef lane fill:#f8fafc,stroke:#cbd5e1,color:#0f172a

User Journey

Mermaid journey chart

journey
  title Documentation business journey
  section Discover and act
    کاربر وارد index.html می‌شود: 4: User,System
    guard نبود token را تشخیص می‌دهد و کاربر را به login می‌فرستد: 5: User,System
    کاربر با ورود محلی token می‌گیرد و به صفحه مقصد برمی‌گردد: 3: User,System
    داشبورد پروژه‌ها و شاخص‌ها را نمایش می‌دهد: 4: User,System
    کاربر از navigation یا جستجو وارد صفحات پروژه می‌شود: 5: User,System
    Mermaid diagramها رندر می‌شوند و در modal قابل مشاهده هستند: 3: User,System

شواهد و منابع بیزینسی خوانده‌شده

  • README.md

Endpointهای پشتیبان جریان‌ها

  • Endpoint مستقیمی برای جریان‌ها پیدا نشد.

ابهام‌ها

جزئیات SLA، مالک هر مرحله، exception pathها و تصمیم‌های دقیق BPMN در بعضی پروژه‌ها در کد کامل نیست و برای مدل فرایندی نهایی نیازمند بررسی انسانی است.