Skip to content

docs: add information architecture and functional map diagrams#14

Merged
singyichen merged 2 commits intomainfrom
docs/information-architecture
Mar 26, 2026
Merged

docs: add information architecture and functional map diagrams#14
singyichen merged 2 commits intomainfrom
docs/information-architecture

Conversation

@singyichen
Copy link
Copy Markdown
Owner

Summary

  • Add docs/ia/ia-diagram.md — Label Suite formal IA diagram organized by page, covering 7 modules with detailed sub-page hierarchy
  • Add docs/ia/information-architecture.md — early graph LR draft (kept for reference)
  • Add docs/ia/label-studio-functional-map.md — Label Studio functional map for comparison against Label Suite

IA Module Structure

Module Pages
Dashboard 3
Account Module 2 (+2 SSO providers)
Task Management Module 3 (+6 sub-items)
Annotation Task Module 4
Annotator Management Module 4 (+3 sub-items)
Dataset Analysis Module 2 (+5 sub-items)
System Management Module 2 (+3 roles)

Test Plan

  • Mermaid syntax is valid and renders correctly on GitHub
  • All modules and pages are consistent with the XMind IA diagram
  • Label Studio functional map content is sourced from docs/research/tool-analysis.md

🤖 Generated with Claude Code

- docs/ia/ia-diagram.md: Label Suite IA with 7 modules (儀表板,
  帳號, 任務管理, 標記任務, 標記員管理, 資料集分析, 系統管理)
  and detailed page hierarchy per module
- docs/ia/information-architecture.md: earlier graph LR draft
- docs/ia/label-studio-functional-map.md: Label Studio functional
  map for comparison reference

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
@qodo-code-review
Copy link
Copy Markdown

Review Summary by Qodo

Add information architecture and functional map diagrams

📝 Documentation

Grey Divider

Walkthroughs

Description
• Add three documentation files with information architecture diagrams
• Label Suite IA diagram with 7 modules and detailed page hierarchy
• Information architecture graph LR draft for reference
• Label Studio functional map for tool comparison
Diagram
flowchart LR
  A["Documentation Files"] --> B["Label Suite IA Diagram"]
  A --> C["IA Graph LR Draft"]
  A --> D["Label Studio Functional Map"]
  B --> B1["7 Modules with Pages"]
  C --> C1["Reference Architecture"]
  D --> D1["Tool Comparison"]
Loading

Grey Divider

File Changes

1. docs/ia/ia-diagram.md 📝 Documentation +71/-0

Label Suite formal IA diagram with modules

• Creates formal information architecture diagram for Label Suite
• Organizes system into 7 modules (Dashboard, Account, Task Management, Annotation Task, Annotator
 Management, Dataset Analysis, System Management)
• Includes detailed page hierarchy and sub-items for each module
• Uses Mermaid graph TD with color-coded styling for visual distinction

docs/ia/ia-diagram.md


2. docs/ia/information-architecture.md 📝 Documentation +66/-0

IA graph LR draft for reference

• Provides alternative graph LR format for information architecture
• Covers same functional areas as ia-diagram.md with different visualization approach
• Includes login flows, dashboard, task management, annotation interface, annotator management, and
 dataset analysis
• Kept as reference draft for comparison purposes

docs/ia/information-architecture.md


3. docs/ia/label-studio-functional-map.md 📝 Documentation +52/-0

Label Studio functional map for comparison

• Documents Label Studio functional map for tool comparison
• Covers 6 main functional areas (Account & Access, Project Management, Annotation Tasks, Annotation
 Interface, Data Export, Deployment)
• Sourced from existing docs/research/tool-analysis.md
• Uses Mermaid graph LR with color-coded module styling

docs/ia/label-studio-functional-map.md


Grey Divider

Qodo Logo

@qodo-code-review
Copy link
Copy Markdown

qodo-code-review bot commented Mar 26, 2026

Code Review by Qodo

🐞 Bugs (0) 📘 Rule violations (0) 📎 Requirement gaps (0) 📐 Spec deviations (0)

Grey Divider


Action required

1. Unmarked IA doc conflict🐞 Bug ⚙ Maintainability
Description
docs/ia/information-architecture.md presents an IA diagram that conflicts with docs/ia/ia-diagram.md
(e.g., it omits the 系統管理模組 module entirely). Without an explicit “draft/outdated” disclaimer or a
rename, readers can easily treat the wrong diagram as authoritative and plan
implementation/navigation incorrectly.
Code

docs/ia/information-architecture.md[R1-17]

+# Label Suite — 資訊架構(Information Architecture)
+
+```mermaid
+graph LR
+  Root([Label Suite])
+
+  Root --> Login[登入]
+  Root --> Dashboard[儀表板]
+  Root --> Task[標記任務]
+  Root --> Annotate[標記介面]
+  Root --> Annotator[標記員管理]
+  Root --> Dataset[資料集分析]
+
+
+  Login --> L1[Google SSO]
+  Login --> L2[GitHub SSO]
+
Evidence
The newly added IA draft lists only six top-level nodes under Root and does not include any system
management module, while the other newly added IA diagram defines seven modules including 系統管理模組;
this is an objective mismatch between two documents in the same docs/ia namespace with no in-file
indication that one is non-authoritative.

docs/ia/information-architecture.md[1-17]
docs/ia/ia-diagram.md[7-13]

Agent prompt
The issue below was found during a code review. Follow the provided context and guidance below and implement a solution

## Issue description
`docs/ia/information-architecture.md` and `docs/ia/ia-diagram.md` both describe Label Suite IA but disagree on top-level modules (e.g., draft omits 系統管理模組). The draft file currently looks canonical, so it can mislead readers.
## Issue Context
This repo doesn’t appear to have a docs build/nav system enforcing “single source of truth”, so clarity has to be in the markdown itself.
## Fix Focus Areas
- docs/ia/information-architecture.md[1-20]
- docs/ia/ia-diagram.md[1-15]
## What to change
- Add a prominent notice at the top of `information-architecture.md` (e.g., **Draft / outdated — kept for reference; see `ia-diagram.md` for the current IA**).
- Optionally rename `information-architecture.md` to `information-architecture-draft.md` (or similar) and, if renamed, ensure any future references point to the canonical `ia-diagram.md`.

ⓘ Copy this prompt and use it to remediate the issue with your preferred AI generation tools


Grey Divider

ⓘ The new review experience is currently in Beta. Learn more

Grey Divider

Qodo Logo

@singyichen singyichen merged commit c6f6539 into main Mar 26, 2026
6 checks passed
@singyichen singyichen deleted the docs/information-architecture branch March 26, 2026 09:58
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant