You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
|`docs/<module-name>/links.md`|`templates/links-template.md`| When user provides external links (Figma, Feishu, Slack, Jira) |
46
+
|`docs/<module-name>/links.md`|`templates/links-template.md`| When user provides external links (Figma, Feishu, Slack, Jira, GitHub) |
47
47
|`docs/<module-name>/tech-design.md`|`templates/tech-design-template.md`| Always — this is required for every module |
48
48
|`docs/<module-name>/tech-design-part2.md`|`templates/tech-design-template.md` (sections only) | When `tech-design.md` exceeds ~500 lines; split overflow sections here |
49
49
|`docs/<module-name>/schedule.md`|`templates/schedule-template.md`| When user provides timeline or asks for a schedule |
@@ -52,10 +52,11 @@ For each file to create, copy the corresponding template and fill in the content
52
52
### Step 4: Fill In Each File
53
53
54
54
#### links.md
55
-
- Fill in the four rows: Figma, Feishu Doc, Slack channel, Jira epic
55
+
- Fill in the five rows: Figma, Feishu Doc, Slack channel, Jira epic, GitHub repository
56
56
- Use the exact URLs and channel names provided by the user
57
-
- If the user did not provide a link for one of the four tools, leave it as `#` (placeholder)
57
+
- If the user did not provide a link for one of the five tools, leave it as `#` (placeholder)
58
58
- Do not add rows for tools not in the template (no GitHub Issues, Linear, Confluence, Notion, etc.)
59
+
-**GitHub MCP**: when the user provides a GitHub repository URL, use the GitHub MCP tools to read the repository content (file structure, key source files, existing README, API definitions) and incorporate the findings into `tech-design.md` — use it to understand the current codebase before writing the design
59
60
60
61
#### tech-design.md
61
62
- Fill in ALL sections from the template; mark sections as "N/A" if not applicable — do not remove them
0 commit comments