@ngocsangairvds/vsaf 3.1.0 → 3.1.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -1,169 +1,169 @@
1
1
  ---
2
2
  name: vsaf-doc-srs
3
- description: Viết tài liệu SRS (Software Requirements Specification) từ PRD đã có. Dùng sau /vsaf-doc-prd. Theo workflow BA chuẩn với template SRS feature-level.
3
+ description: Write SRS (Software Requirements Specification) from an existing PRD. Use after /vsaf-doc-prd. Follows standard BA workflow with feature-level SRS template.
4
4
  ---
5
5
 
6
6
  # VSAF Doc SRS
7
7
 
8
- ## Mục tiêu
9
- Phân tích PRD viết tài liệu SRS feature-level theo template chuẩn đảm bảo truy xuất được từ PRD → Use Cases → Màn hình → Epic/Story.
8
+ ## Goal
9
+ Analyze the PRD and write a feature-level SRS following a standard template ensuring traceability from PRD → Use Cases → Screens → Epic/Story.
10
10
 
11
- **Your Role:** Business Analyst chuyên nghiệp viết SRS theo quy trình chuẩn.
11
+ **Your Role:** Professional Business Analyst — write SRS following a standard process.
12
12
 
13
- ## Điều kiện tiên quyết
14
- - Phải đã chạy `/vsaf-doc-prd` PRD được approve trước khi chạy skill này.
13
+ ## Prerequisites
14
+ - Must have run `/vsaf-doc-prd` and have an approved PRD before running this skill.
15
15
 
16
- ## Cấu hình
16
+ ## Configuration
17
17
  ```yaml
18
18
  outputDir: docs/project/srs
19
19
  featureTemplate: _bmad/bmm/1-analysis/bmad-document-project/templates/srs-feature-template.md
20
20
  systemTemplate: _bmad/bmm/1-analysis/bmad-document-project/templates/srs-system-template.md
21
21
  ```
22
22
 
23
- ## Các bước thực hiện
23
+ ## Steps
24
24
 
25
- ### Bước 0 — Kiểm tra đầu vào
25
+ ### Step 0 — Validate inputs
26
26
 
27
- Trước khi bắt đầu, kiểm tra xem user đã cung cấp đủ thông tin chưa:
27
+ Before starting, check if the user has provided sufficient information:
28
28
 
29
- **Yêu cầu bắt buộc:**
30
- - [ ] Tài liệu PRD (file path hoặc nội dung) — thường `docs/project/planning-artifacts/prd-[feature].md`
31
- - [ ] Figma link (URL figma.com/design/...) — nếu
29
+ **Required:**
30
+ - [ ] PRD document (file path or content) — typically at `docs/project/planning-artifacts/prd-[feature].md`
31
+ - [ ] Figma link (URL figma.com/design/...) — if available
32
32
 
33
- Nếu thiếu PRD, **dừng lại ngay** yêu cầu user cung cấp:
33
+ If PRD is missing, **stop immediately** and request from the user:
34
34
 
35
35
  ```
36
- Để viết tài liệu SRS, tôi cần bạn cung cấp:
36
+ To write the SRS document, I need you to provide:
37
37
 
38
- [liệt những gì còn thiếu]
38
+ [list what is missing]
39
39
 
40
- Vui lòng cung cấp:
41
- 1. File PRD: đường dẫn file hoặc paste nội dung vào đây
42
- 2. Figma link (nếu ): URL dạng https://www.figma.com/design/...
43
- 3. Flow/Feature cần viết SRS (VD: FR-1, FR-2,...)
40
+ Please provide:
41
+ 1. PRD file: file path or paste the content here
42
+ 2. Figma link (if available): URL like https://www.figma.com/design/...
43
+ 3. Flow/Feature to write SRS for (e.g., FR-1, FR-2,...)
44
44
  ```
45
45
 
46
- Chỉ tiếp tục khi đã đủ PRD.
46
+ Only continue when the PRD is available.
47
47
 
48
48
  ---
49
49
 
50
- ### Bước 1 — Xác định mode: Tạo mới hay Chỉnh sửa
51
- - Kiểm tra xem đã SRS trong `docs/project/srs/` cho feature này chưa
52
- - **Nếu chưa có** → Mode: CREATE
53
- - **Nếu đã có** → Mode: EDIT
54
- - Hỏi user: "SRS đã tồn tại. Bạn muốn tạo mới hoàn toàn hay chỉnh sửa?"
55
- - Mode EDIT: dùng skill `bmad-edit-prd` để chỉnh sửa SRS đã có
50
+ ### Step 1 — Determine mode: Create or Edit
51
+ - Check if an SRS already exists in `docs/project/srs/` for this feature
52
+ - **If none exists** → Mode: CREATE
53
+ - **If one exists** → Mode: EDIT
54
+ - Ask user: "An SRS already exists. Do you want to create a new one from scratch or edit the existing one?"
55
+ - Mode EDIT: use skill `bmad-edit-prd` to edit the existing SRS
56
56
 
57
57
  ---
58
58
 
59
- ### Bước 2 — Đọc & phân tích PRD
59
+ ### Step 2 — Read & analyze PRD
60
60
 
61
- Đọc toàn bộ tài liệu PRD. Trích xuất tổ chức thông tin theo cấu trúc:
61
+ Read the entire PRD document. Extract and organize information into the following structure:
62
62
 
63
- **2.1 Mục tiêu dự án**
63
+ **2.1 Project objectives**
64
64
  - Business objective, Problem statement, Success criteria
65
65
 
66
- **2.2 Phạm vi (Scope)**
67
- - In-scope features / Sub-FRs, Out-of-scope, Các module/màn hình chính
66
+ **2.2 Scope**
67
+ - In-scope features / Sub-FRs, Out-of-scope, Main modules/screens
68
68
 
69
69
  **2.3 Actors & Use Cases**
70
- - Danh sách các actor (vai trò người dùng), User stories / use cases đã đề cập
70
+ - List of actors (user roles), User stories / use cases mentioned
71
71
 
72
72
  **2.4 Business Rules**
73
- - Quy tắc nghiệp vụ quan trọng, Constraints & assumptions
73
+ - Key business rules, Constraints & assumptions
74
74
 
75
75
  **2.5 Non-functional Requirements**
76
- - Performance, security, scalability, v.v. (nếu )
76
+ - Performance, security, scalability, etc. (if applicable)
77
77
 
78
- Sau bước này, xuất ra **"Tóm tắt PRD"** để user xác nhận trước khi sang bước 3.
78
+ After this step, output a **"PRD Summary"** for user confirmation before proceeding to step 3.
79
79
 
80
80
  ---
81
81
 
82
- ### Bước 3 — So sánh PRD với Figma (nếu Figma)
82
+ ### Step 3 — Compare PRD with Figma (if Figma is available)
83
83
 
84
- Nếu Figma link, dùng Figma MCP tools để đọc design:
85
- 1. Gọi `get_figma_data` để lấy danh sách pages/frames
86
- 2. Download screenshots cho từng màn hình chính
84
+ If a Figma link is available, use Figma MCP tools to read the design:
85
+ 1. Call `get_figma_data` to get the list of pages/frames
86
+ 2. Download screenshots for each main screen
87
87
 
88
- So sánh và ghi nhận:
88
+ Compare and record:
89
89
 
90
- | Hạng mục | PRD nói | Figma thiết kế | Trạng thái |
90
+ | Item | PRD states | Figma design | Status |
91
91
  |---|---|---|---|
92
- | [Feature/Screen] | ... | ... | Khớp / ⚠️ Khác biệt / Chưa rõ |
92
+ | [Feature/Screen] | ... | ... | Matched / Discrepancy / Unclear |
93
93
 
94
- **Phân tích gap:**
95
- - **Gap 1 — Thiếu trong Figma:** Features trong PRD nhưng không thấy trong design
96
- - **Gap 2 — Thêm trong Figma:** UI elements trong Figma nhưng không đề cập trong PRD
97
- - **Gap 3 — Mâu thuẫn:** Thông tin không nhất quán giữa hai nguồn
94
+ **Gap analysis:**
95
+ - **Gap 1 — Missing in Figma:** Features in PRD but not found in the design
96
+ - **Gap 2 — Added in Figma:** UI elements in Figma but not mentioned in the PRD
97
+ - **Gap 3 — Conflicts:** Inconsistent information between the two sources
98
98
 
99
- Nếu không Figma: ghi "Chưa Figma design — cần UX team cung cấp" tại mục 2 của SRS.
99
+ If no Figma: note "No Figma design available — UX team needs to provide" in section 2 of the SRS.
100
100
 
101
- Sau bước này, xuất ra **"Báo cáo Gap Analysis"** hỏi user muốn clarify gap nào trước khi viết SRS không.
101
+ After this step, output a **"Gap Analysis Report"** and ask the user if they want to clarify any gaps before writing the SRS.
102
102
 
103
103
  ---
104
104
 
105
- ### Bước 4 — Viết tài liệu SRS theo Feature Template
105
+ ### Step 4 — Write SRS following the Feature Template
106
106
 
107
- Đọc template tại `_bmad/bmm/1-analysis/bmad-document-project/templates/srs-feature-template.md` viết SRS **đúng theo cấu trúc template**, bao gồm đầy đủ 12 sections (011):
107
+ Read the template at `_bmad/bmm/1-analysis/bmad-document-project/templates/srs-feature-template.md` and write the SRS **strictly following the template structure**, including all 12 sections (0-11):
108
108
 
109
- 0. **Preamble** — Thông tin tài liệu, bảng ghi nhận thay đổi, bảng phê duyệt
110
- 1. **Introduction** — Mục tiêu, phạm vi, tài liệu tham chiếu
111
- 2. **Business Context** — Business objective, actors, use cases tổng quan
109
+ 0. **Preamble** — Document information, change log table, approval table
110
+ 1. **Introduction** — Objectives, scope, reference documents
111
+ 2. **Business Context** — Business objective, actors, use cases overview
112
112
  3. **System Overview** — High-Level Activity Diagram + Architecture
113
113
  4. **Data Model** — Entity tables, ER diagram, Kafka Events, API Endpoints
114
- 5. **Functional Requirements** — Đặc tả Use Cases chi tiết. Mỗi UC gồm:
115
- - **Màn hình** — Bảng chi tiết controls từng màn hình thuộc UC
116
- - **Luồng nghiệp vụ** — Sequence diagram (PlantUML) + Activity diagram (PlantUML, nếu cần)
117
- - Màn hình dùng chung: đặt bảng đầy đủ tại UC đầu tiên, UC sau ghi tham chiếu
114
+ 5. **Functional Requirements** — Detailed Use Case specifications. Each UC includes:
115
+ - **Screens** — Detailed controls table for each screen in the UC
116
+ - **Business flows** — Sequence diagram (PlantUML) + Activity diagram (PlantUML, if needed)
117
+ - Shared screens: place the full table at the first UC, subsequent UCs reference it
118
118
  6. **State & Behavioral Models** — State diagrams (Mermaid stateDiagram-v2), entity lifecycle
119
119
  7. **Business Rules & Validation** — BR table + Validation Rules + Error Codes
120
- 8. **NFR** — Non-functional requirements đặc thù cho flow
120
+ 8. **NFR** — Non-functional requirements specific to the flow
121
121
  9. **Constraints** — Constraints, assumptions, dependencies, transition requirements
122
- 10. **RTM** — Ma trận truy xuất: PRD FR → UC → Màn hình → Epic/Story → BR → AC → Test Case
123
- 11. **Appendix** — Figma Mapping tables, Screen List, Chức năng ảnh hưởng, Gap Analysis
122
+ 10. **RTM** — Requirements Traceability Matrix: PRD FR → UC → Screen → Epic/Story → BR → AC → Test Case
123
+ 11. **Appendix** — Figma Mapping tables, Screen List, Affected features, Gap Analysis
124
124
 
125
- **Quy tắc viết:**
126
- - Viết bằng **tiếng Việt** trừ khi user yêu cầu tiếng Anh
127
- - Giữ nguyên business rules từ PRD, không tự ý thay đổi logic nghiệp vụ
128
- - Mỗi Use Case phải có: Precondition, Main flow, Alternative flow, Exception flow, Postcondition
129
- - Activity/Flow diagrams dùng Mermaid `flowchart TD`; State diagrams dùng `stateDiagram-v2`; ER dùng `erDiagram`
130
- - Nếu thông tin chưa đủ ghi `{{Cần bổ sung}}` liệt phần Gap Analysis
125
+ **Writing rules:**
126
+ - Write in **English** by default unless user requests otherwise
127
+ - Preserve business rules from the PRD, do not arbitrarily change business logic
128
+ - Each Use Case must have: Precondition, Main flow, Alternative flow, Exception flow, Postcondition
129
+ - Activity/Flow diagrams use Mermaid `flowchart TD`; State diagrams use `stateDiagram-v2`; ER uses `erDiagram`
130
+ - If information is insufficientmark as `{{TBD}}` and list in the Gap Analysis section
131
131
 
132
132
  ---
133
133
 
134
- ### Bước 5 — Validate SRS (BMAD validate)
135
- - Dùng skill `bmad-validate-prd` để validate SRS vừa sinh/sửa
136
- - Kiểm tra: FRs đủ rõ ràng? NFRs đo lường được? Acceptance criteria kiểm chứng được?
137
- - Nếu issues: fix ngay trong SRS, không chờ đến build
138
- - Ghi nhận validation result (PASS/FAIL + findings)
134
+ ### Step 5 — Validate SRS (BMAD validate)
135
+ - Use skill `bmad-validate-prd` to validate the generated/edited SRS
136
+ - Check: Are FRs clear enough? Are NFRs measurable? Are acceptance criteria verifiable?
137
+ - If issues found: fix immediately in the SRS, do not wait until build
138
+ - Record validation result (PASS/FAIL + findings)
139
139
 
140
140
  ---
141
141
 
142
- ### Bước 6 — Lưu file SRS
143
- Lưu tài liệu SRS vào: `docs/project/srs/SRS-[tên-dự-án]-[FR-ID]-[tên-feature]-v1.0.md`
142
+ ### Step 6 — Save SRS file
143
+ Save the SRS document to: `docs/project/srs/SRS-[project-name]-[FR-ID]-[feature-name]-v1.0.md`
144
144
 
145
- ### Bước 7 — Output cho user
145
+ ### Step 7 — Output to user
146
146
  ```
147
- ## SRS đã tạo/cập nhật
147
+ ## SRS Created/Updated
148
148
 
149
149
  ### File
150
- - docs/project/srs/SRS-[tên-dự-án]-[FR-ID]-[tên-feature]-v1.0.md
150
+ - docs/project/srs/SRS-[project-name]-[FR-ID]-[feature-name]-v1.0.md
151
151
  - Mode: [CREATE / EDIT]
152
- - Use Cases viết: [N]
153
- - Validation: [PASS / FAIL — chi tiết nếu fail]
152
+ - Use Cases written: [N]
153
+ - Validation: [PASS / FAIL — details if fail]
154
154
 
155
- ### Gaps cần confirm
156
- - [Danh sách gaps quan trọng cần team confirm]
155
+ ### Gaps to confirm
156
+ - [List of important gaps that need team confirmation]
157
157
 
158
- ### Phần chưa hoàn thiện
159
- - [Các phần SRS còn {{...}} cần bổ sung thêm]
158
+ ### Incomplete sections
159
+ - [SRS sections still containing {{...}} that need additional input]
160
160
 
161
161
  ## Next step
162
- Chạy /vsaf-test docs/project/srs/SRS-[...].md để sinh testcase
162
+ Run /vsaf-test docs/project/srs/SRS-[...].md to generate testcases
163
163
  ```
164
164
 
165
- ## Lưu ý
166
- - Không bắt đầu code trong bước này
167
- - Nếu scope quá lớn (>3 modules): đề nghị split thành nhiều PRs
165
+ ## Notes
166
+ - Do not start coding in this step
167
+ - If scope is too large (>3 modules): suggest splitting into multiple PRs
168
168
  - Commit docs: `git commit -m "docs: srs for <feature>"`
169
- - Nếu mode EDIT testcases bị ảnh hưởng: cảnh báo user re-run `/vsaf-test`
169
+ - If mode is EDIT and existing testcases are affected: warn user to re-run `/vsaf-test`
@@ -1,61 +1,61 @@
1
1
  ---
2
2
  name: vsaf-docs
3
- description: Documentation & knowledge sync — cập nhật docs, sinh project context, build wiki. Dùng sau /vsaf-ship hoặc cuối sprint để đảm bảo knowledge không bị mất.
3
+ description: Documentation & knowledge sync — update docs, generate project context, build wiki. Use after /vsaf-ship or at end of sprint to ensure knowledge is not lost.
4
4
  ---
5
5
 
6
6
  # VSAF Docs
7
7
 
8
- ## Mục tiêu
9
- Đảm bảo documentation luôn cập nhật AI agents đủ context.
8
+ ## Goal
9
+ Ensure documentation is always up to date and AI agents have sufficient context.
10
10
 
11
11
  ## Input
12
- `$ARGUMENTS` — scope cần document:
13
- - *(không argument)* — full documentation refresh
14
- - `<module>` — document module cụ thể
15
- - `context` — chỉ sinh project-context.md
16
-
17
- ## Khi nào dùng
18
- - Sau mỗi sprint (batch update)
19
- - Sau ship feature lớn (>3 modules thay đổi)
20
- - Khi onboard team member mới
21
- - Khi AI agent gặp khó hiểu codebase
22
-
23
- ## Các bước thực hiện
24
-
25
- ### Bước 1 — Scan current state
26
- - Dùng `mcp__gitnexus__query` để scan codebase hiện tại
27
- - So sánh: docs hiện tại vs code hiện tại tìm docs lạc hậu
28
-
29
- ### Bước 2 — Generate project documentation
30
- - Dùng skill `bmad-document-project` để sinh/cập nhật project docs
31
- - Output: tả architecture, module breakdown, API endpoints, data flows
32
- - Lưu vào `docs/project/`
33
-
34
- ### Bước 3 — Generate project context for AI
35
- - Dùng skill `bmad-generate-project-context` để tạo `project-context.md`
36
- - File này = instructions cho AI agents: conventions, patterns, do/don't
37
- - Lưu tại root project
38
-
39
- ### Bước 4 — Tech writing review
40
- - Dùng skill `bmad-agent-tech-writer` (Paige) để review docs vừa sinh
41
- - Paige sẽ: fix unclear sections, add missing context, ensure consistency
42
-
43
- ### Bước 5 — Editorial polish
44
- - Dùng skill `bmad-editorial-review-prose` — clean up writing quality
12
+ `$ARGUMENTS` — scope to document:
13
+ - *(no argument)* — full documentation refresh
14
+ - `<module>` — document a specific module
15
+ - `context` — only generate project-context.md
16
+
17
+ ## When to use
18
+ - After each sprint (batch update)
19
+ - After shipping a large feature (>3 modules changed)
20
+ - When onboarding a new team member
21
+ - When an AI agent struggles to understand the codebase
22
+
23
+ ## Steps
24
+
25
+ ### Step 1 — Scan current state
26
+ - Use `mcp__gitnexus__query` to scan the current codebase
27
+ - Compare: current docs vs current code find outdated docs
28
+
29
+ ### Step 2 — Generate project documentation
30
+ - Use skill `bmad-document-project` to generate/update project docs
31
+ - Output: architecture description, module breakdown, API endpoints, data flows
32
+ - Save to `docs/project/`
33
+
34
+ ### Step 3 — Generate project context for AI
35
+ - Use skill `bmad-generate-project-context` to create `project-context.md`
36
+ - This file = instructions for AI agents: conventions, patterns, do/don't
37
+ - Save at project root
38
+
39
+ ### Step 4 — Tech writing review
40
+ - Use skill `bmad-agent-tech-writer` (Paige) to review the generated docs
41
+ - Paige will: fix unclear sections, add missing context, ensure consistency
42
+
43
+ ### Step 5 — Editorial polish
44
+ - Use skill `bmad-editorial-review-prose` — clean up writing quality
45
45
  - Fix: passive voice, jargon, ambiguity, grammar
46
- - Dùng skill `bmad-editorial-review-structure` — improve doc organization
46
+ - Use skill `bmad-editorial-review-structure` — improve doc organization
47
47
  - Fix: duplicated content, poor ordering, missing sections
48
48
 
49
- ### Bước 6 — Distill for LLM consumption
50
- - Dùng skill `bmad-distillator` với docs dài (>500 lines)
51
- - Tạo phiên bản compressed — giữ nguyên thông tin, giảm token count
52
- - Lưu distilled version cạnh original: `[name].distilled.md`
49
+ ### Step 6 — Distill for LLM consumption
50
+ - Use skill `bmad-distillator` for long docs (>500 lines)
51
+ - Create a compressed version preserve all information, reduce token count
52
+ - Save distilled version alongside original: `[name].distilled.md`
53
53
 
54
- ### Bước 7 — Index all docs
55
- - Dùng skill `bmad-index-docs` cho mỗi folder trong `docs/`
56
- - Sinh/cập nhật `index.md` — mục lục tất cả files + tả ngắn
54
+ ### Step 7 — Index all docs
55
+ - Use skill `bmad-index-docs` for each folder in `docs/`
56
+ - Generate/update `index.md` — table of contents of all files + short descriptions
57
57
 
58
- ### Bước 8 — Output cho user
58
+ ### Step 8 — Output to user
59
59
  ```
60
60
  ## Documentation Sync Complete
61
61
 
@@ -74,8 +74,8 @@ description: Documentation & knowledge sync — cập nhật docs, sinh project
74
74
  Documentation is current. Continue with /vsaf-plan or /vsaf-sprint.
75
75
  ```
76
76
 
77
- ## Lưu ý
78
- - Flow này **không sửa code** — chỉ documentation
79
- - Chạy ít nhất 1 lần mỗi sprint hoặc sau mỗi major ship
80
- - Commit tất cả docs: `git commit -m "docs: sync documentation [sprint N]"`
81
- - Nếu docs >1000 lines: luôn tạo distilled version
77
+ ## Notes
78
+ - This flow **does not modify code** — documentation only
79
+ - Run at least once per sprint or after each major ship
80
+ - Commit all docs: `git commit -m "docs: sync documentation [sprint N]"`
81
+ - If docs >1000 lines: always create a distilled version
@@ -1,46 +1,81 @@
1
1
  ---
2
2
  name: vsaf-onboard
3
- description: Hiểu toàn bộ context dự án mới. Dùng khi lần đầu tiếp nhận project, cần nắm kiến trúc, decisions cũ, codebase trước khi làm bất cứ điều gì.
3
+ description: Understand the full context of a new project. Use when first onboarding to a project, needing to grasp the architecture, past decisions, and codebase before doing anything.
4
4
  ---
5
5
 
6
6
  # VSAF Onboard
7
7
 
8
- ## Mục tiêu
9
- Xây dựng full mental model về dự án trước khi chạm vào bất kỳ code nào.
8
+ ## Objective
9
+ Build a full mental model of the project before touching any code.
10
10
 
11
- ## Các bước thực hiện
11
+ ## Steps
12
12
 
13
- ### Bước 1 — Code intelligence (GitNexus)
14
- - Dùng `mcp__gitnexus__query` với query rộng (ví dụ: "main entry point", "core module") để lấy codebase overview
15
- - Dùng `mcp__gitnexus__group_list` để xem các functional clusters
16
- - Nếu cần drill-down symbol cụ thể: dùng `mcp__gitnexus__context` với param `name` là tên symbol đó
17
- - Tóm tắt: execution flows quan trọng, symbols có nhiều dependencies nhất
13
+ ### Step 1 — Codebase overview (GitNexus resource)
14
+ - Read `gitnexus://repo/{name}/context` get codebase overview:
15
+ - Size, index freshness, health metrics
16
+ - Overview of symbols, relationships
18
17
 
19
- ### Bước 2 — Đọc tài liệu dự án
20
- - Đọc `docs/project/planning-artifacts/` để tìm PRD, ADR, architecture docs
21
- - Đọc `docs/project/srs/` để tìm SRS đã
22
- - Tóm tắt: các quyết định kiến trúc quan trọng đã document
18
+ ### Step 2 — Functional areas (GitNexus resource)
19
+ - Read `gitnexus://repo/{name}/clusters` functional areas + cohesion scores
20
+ - Understand what functional groups the codebase is divided into
23
21
 
24
- ### Bước 3 — Output cho user
25
- Trình bày tóm tắt theo format:
22
+ ### Step 3 — Execution flows (GitNexus resource)
23
+ - Read `gitnexus://repo/{name}/processes` all execution flows in the codebase
24
+ - Understand how data flows through the system
25
+
26
+ ### Step 4 — Module groupings (GitNexus tools)
27
+ - Use `gitnexus_group_list` to view module groups
28
+ - Use `gitnexus_group_query` to view inter-module relationships
29
+ - Understand which modules depend on which
30
+
31
+ ### Step 5 — API surface (GitNexus, for API projects)
32
+ - Use `gitnexus_route_map` to map all API routes → handlers
33
+ - Skip if the project is not an API/web service
34
+
35
+ ### Step 6 — Deep-dive key symbols (GitNexus)
36
+ - Use `gitnexus_context` on 3-5 key symbols (main entry points, core services)
37
+ - Get a 360° view: callers, callees, process participation
38
+ - Identify: hot symbols (many callers), risk areas (high fan-out)
39
+
40
+ ### Step 7 — Read project documentation + synthesize
41
+ - Read `docs/project/planning-artifacts/` to find PRDs, ADRs, architecture docs
42
+ - Read `docs/project/srs/` to find existing SRS documents
43
+ - Synthesize all findings into a project overview
44
+
45
+ ### Step 8 — Output to user
46
+ Present the summary in this format:
26
47
 
27
48
  ```
28
49
  ## Project Overview
29
- [ tả ngắn về dự án]
50
+ [Brief description of the project]
51
+
52
+ ## Codebase Health
53
+ - Symbols: [N] | Relationships: [N] | Execution flows: [N]
54
+ - Index freshness: [fresh / stale — last indexed: date]
55
+
56
+ ## Architecture
57
+ [Main layers/modules and their relationships — from clusters + groups]
58
+
59
+ ## Key Execution Flows
60
+ [Top 5-10 most important flows — from processes]
61
+
62
+ ## API Surface
63
+ [Routes overview — from route_map, or "N/A" if not an API project]
30
64
 
31
- ## Kiến trúc
32
- [Các layer/module chính quan hệ]
65
+ ## Hot Symbols
66
+ [3-5 symbols with the most callers/dependencies from context deep-dive]
33
67
 
34
- ## Patterns đang dùng
68
+ ## Patterns in Use
35
69
  [Tech stack, design patterns, conventions]
36
70
 
37
- ## Decisions quan trọng
38
- [Những team đã quyết định do]
71
+ ## Key Decisions
72
+ [What the team has decided and why from docs]
39
73
 
40
- ## Cần chú ý
74
+ ## Areas of Concern
41
75
  [Risk areas, legacy code, known issues]
42
76
  ```
43
77
 
44
- ## Lưu ý
45
- - KHÔNG sửa bất kỳ file nào trong bước này
46
- - Sau khi hoàn thành: gợi ý user dùng `/vsaf-plan <feature>` để bắt đầu task
78
+ ## Notes
79
+ - Do NOT modify any files during this step
80
+ - If GitNexus index is stale: run `vsaf index` before onboarding
81
+ - After completion: suggest the user run `/vsaf-plan <feature>` to begin a task