devdocs-requirements
npx skills add https://github.com/ab300819/skills --skill devdocs-requirements
Agent 安装分布
Skill 文档
éæ±æ©å
å°ç¨æ·ç®çéæ±æ©å±ä¸ºç»æåçéæ±ææ¡£ï¼å»ºç«åè½ç¹ãç¨æ·æ äºãéªæ¶æ åçå ³èä½ç³»ã
è¯è¨è§å
- æ¯æä¸è±ææé®
- ç»ä¸ä¸æåå¤
- 使ç¨ä¸æçæææ¡£
è§¦åæ¡ä»¶
- ç¨æ·æä¾åè½éæ±ææ³æ³
- ç¨æ·è¦æ±å建/ç¼å PRD
- ç¨æ·æ³è¦æ¾æ¸ æè®°å½éæ±
- æ¥èª
/devdocs-featureçå¢é鿱姿 - ç¨æ·éè¦è¡¥å 项ç®èæ¯ä¿¡æ¯ï¼å°¤å ¶æ¯ retrofit åï¼
- ç¨æ·æä¾åèèµæãé¢åç¥è¯ãææ¯çº¦æ
è¿è¡æ¨¡å¼
/devdocs-requirements â èªå¨æ£æµæ¨¡å¼
/devdocs-requirements --incremental â 强å¶å¢é模å¼ï¼è¿½å åè½ç¹ï¼
/devdocs-requirements --context â èæ¯ä¿¡æ¯æ¨¡å¼ï¼è¿½å /æ´æ°èæ¯ï¼
| æ¨¡å¼ | è§¦åæ¡ä»¶ | 说æ |
|---|---|---|
| åå§æ¨¡å¼ | æ 01-requirements.md |
ä»é¶åå»ºéæ±ææ¡£ |
| å¢éæ¨¡å¼ | å·²æ 01-requirements.md |
æ«æç¼å· + 追å åè½ç¹/ç¨æ·æ äº/éªæ¶æ å |
| èæ¯ä¿¡æ¯æ¨¡å¼ | --context æç¨æ·è¦è¡¥å
èæ¯ |
追å /æ´æ°”èæ¯ä¸ç®æ ”ç« è |
工使µç¨
åå§æ¨¡å¼
1. çè§£éæ±
â
â¼
2. æ¢ç´¢ä»£ç åºï¼å¦éç¨ï¼
â
â¼
3. è¯å«åè½ç¹ (F-XXX)
â
â¼
4. ç¼åç¨æ·æ
äº (US-XXX)
â
â¼
5. å®ä¹éªæ¶æ å (AC-XXX)
â
â¼
6. çæè¿½æº¯ç©éµ
â
â¼
7. ç¨æ·ç¡®è®¤
å¢é模å¼
1. æ«æç°æç¼å·
â
âââ 读å 01-requirements.md
âââ è·å F/US/AC æå¤§ç¼å·
â
â¼
2. çè§£æ°å¢éæ±
â
â¼
3. 追å åè½ç¹/ç¨æ·æ
äº/éªæ¶æ å
â
âââ å»¶ç»ç°æç¼å·
âââ æ 注å¢éçæ¬åæ¥æ
â
â¼
4. æ´æ°è¿½æº¯ç©éµ
â
â¼
5. ç¨æ·ç¡®è®¤
â
â¼
6. è¿åæ°å¢ç¼å·å表ï¼ä¾è°ç¨æ¹ä½¿ç¨ï¼
èæ¯ä¿¡æ¯æ¨¡å¼
1. 读åç°æææ¡£
â
âââ æ£æ¥ 01-requirements.md æ¯å¦åå¨
âââ æåç°æ"èæ¯ä¸ç®æ "ç« èå
容
â
â¼
2. æ¶éèæ¯ä¿¡æ¯
â
âââ å¼å¯¼ç¨æ·æä¾ä¿¡æ¯ï¼AskUserQuestionï¼
âââ æ¥æ¶ç¨æ·ç´æ¥è¾å
¥
âââ ä»æä»¶è·¯å¾æåï¼Readï¼
âââ ä» URL æåæè¦ï¼WebFetchï¼
â
â¼
3. æ´åä¿¡æ¯
â
âââ åå¹¶å°"èæ¯ä¸ç®æ "ç« è
âââ è¡¥å
å°"ææ¯çº¦æ"åç« è
âââ è¡¥å
å°"åèèµæ"åç« è
â
â¼
4. æ´æ°ææ¡£
â
â¼
5. ç¨æ·ç¡®è®¤
ç¼å·è§è
| ç±»å | åç¼ | æ ¼å¼ | ç¤ºä¾ |
|---|---|---|---|
| åè½ç¹ | F | F-XXX | F-001, F-002 |
| ç¨æ·æ äº | US | US-XXX | US-001, US-002 |
| éªæ¶æ å | AC | AC-XXX | AC-001, AC-002 |
ç¼å·è§åï¼
- å ¨å±é¡ºåºç¼å·ï¼ä¸åµå¥
- éè¿è¿½æº¯ç©éµè¡¨è¾¾å ³èå ³ç³»
- ç¼å·ä¸æ¦åé ä¸å¯å¤ç¨
è¾åºæä»¶
主æä»¶ï¼docs/devdocs/01-requirements.md
å¦ææ¡£è¶ è¿ 300 è¡ï¼å¯æå为ï¼
01-requirements.md– æ¦è§ååè½ç¹01-requirements-stories.md– ç¨æ·æ äºè¯¦æ01-requirements-nfr.md– éåè½æ§éæ±
è¯¦ç»æ¨¡æ¿åè§ templates/requirements-template.md
ææ¡£ç»æ
# éæ±ææ¡£ï¼<åè½åç§°>
## 1. èæ¯ä¸ç®æ
## 2. åè½ç¹æ¸
å
## 3. ç¨æ·æ
äº
## 4. éªæ¶æ å
## 5. 追溯ç©éµ
## 6. éåè½æ§éæ±
## 7. èå´è¾¹ç
## 8. é£é©ä¸å设
æ ¸å¿æ¦å¿µ
åè½ç¹ (Feature)
åè½ç¹æ¯ç¨æ·å¯æç¥çç¬ç«åè½åå ã
è¯å«æ¹æ³ï¼
- å¯ä»¥ç¬ç«äº¤ä»åéªè¯
- å¯¹ç¨æ·ææç¡®ä»·å¼
- ç²åº¦éä¸ï¼ä¸è¿å¤§ä¹ä¸è¿å°ï¼
示ä¾ï¼
| ç¼å· | åè½ç¹ | æè¿° | ä¼å
级 |
|------|--------|------|--------|
| F-001 | ç¨æ·æ³¨å | æ°ç¨æ·éè¿é®ç®±æ³¨åè´¦å· | P0 |
| F-002 | ç¨æ·ç»å½ | 已注åç¨æ·ç»å½ç³»ç» | P0 |
| F-003 | å¯ç æ¾å | ç¨æ·éè¿é®ç®±éç½®å¯ç | P1 |
ç¨æ·æ äº (User Story)
ç¨æ·æ äºæè¿°ç¨æ·å¦ä½ä½¿ç¨åè½ç¹å®æç®æ ã
æ ¼å¼ï¼ä½ä¸º <è§è²>ï¼æå¸æ <åè½>ï¼ä»¥ä¾¿ <ä»·å¼>
示ä¾ï¼
| ç¼å· | åè½ç¹ | è§è² | ææ | ç®ç |
|------|--------|------|------|------|
| US-001 | F-001 | æ°ç¨æ· | 使ç¨é®ç®±æ³¨å | è·å¾ç³»ç»è®¿é®æé |
| US-002 | F-001 | æ°ç¨æ· | 设置å®å
¨å¯ç | ä¿æ¤è´¦å·å®å
¨ |
| US-003 | F-002 | 已注åç¨æ· | 使ç¨é®ç®±å¯ç ç»å½ | è¿å
¥ç³»ç» |
éªæ¶æ å (Acceptance Criteria)
éªæ¶æ åå®ä¹ç¨æ·æ äºç宿æ¡ä»¶ï¼æ¯æµè¯ç¨ä¾è®¾è®¡ç便®ã
ååï¼
- å¯éåãå¯éªè¯
- æè¿°é¢æè¡ä¸ºï¼ä¸æè¿°å®ç°
- æ¯ä¸ªç¨æ·æ äºè³å° 2-3 æ¡éªæ¶æ å
示ä¾ï¼
### US-001: 使ç¨é®ç®±æ³¨å
| ç¼å· | æ åæè¿° | éªè¯æ¹å¼ |
|------|----------|----------|
| AC-001 | ææé®ç®±æ ¼å¼å¯ä»¥æäº¤æ³¨å | è¾å
¥ test@example.comï¼æäº¤æå |
| AC-002 | å·²åå¨é®ç®±æ¾ç¤ºé误æç¤º | è¾å
¥å·²æ³¨åé®ç®±ï¼æ¾ç¤º"é®ç®±å·²åå¨" |
| AC-003 | 注åæåååééªè¯é®ä»¶ | æ¶å°å
å«éªè¯é¾æ¥çé®ä»¶ |
追溯ç©éµ
追溯ç©éµå±ç¤ºåè½ç¹ãç¨æ·æ äºãéªæ¶æ åçå ³èå ³ç³»ã
示ä¾ï¼
| åè½ç¹ | ç¨æ·æ
äº | éªæ¶æ å |
|--------|----------|----------|
| F-001 | US-001 | AC-001, AC-002, AC-003 |
| F-001 | US-002 | AC-004, AC-005 |
| F-002 | US-003 | AC-006, AC-007, AC-008 |
å¢é模å¼è¯¦è§£
ç¼å·æ«æ
ä»ç°æææ¡£æåæå¤§ç¼å·ï¼
## å½åç¶æ
| ç±»å | å½åæå¤§ç¼å· | ä¸ä¸ç¼å· |
|------|-------------|----------|
| åè½ç¹ (F) | F-003 | F-004 |
| ç¨æ·æ
äº (US) | US-008 | US-009 |
| éªæ¶æ å (AC) | AC-015 | AC-016 |
è¿½å æ ¼å¼
---
## åè½è¿ä»£ v2: <åè½åç§°> (2024-01-15)
> æ¬æ¬¡æ°å¢ F-004ï¼å
å« 2 ä¸ªç¨æ·æ
äºã5 ä¸ªéªæ¶æ åã
### F-004: <åè½åç§°>
**æè¿°**ï¼<åè½æè¿°>
**ç¨æ·æ
äº**ï¼
| ç¼å· | è§è² | ææ | ç®ç |
|------|------|------|------|
| US-009 | ä½ä¸º<è§è²> | æå¸æ<åè½> | 以便äº<ä»·å¼> |
**éªæ¶æ å**ï¼
- [ ] AC-016: <æ å1>
- [ ] AC-017: <æ å2>
è¿åå¼
å¢é模å¼å®æåï¼è¿åæ°å¢ç¼å·å表ä¾è°ç¨æ¹ä½¿ç¨ï¼
æ°å¢ç¼å·ï¼
- F-004
- US-009, US-010
- AC-016 ~ AC-020
èæ¯ä¿¡æ¯æ¨¡å¼è¯¦è§£
å ¸ååºæ¯
- Retrofit åè¡¥å ï¼ä»£ç é忍坼宿åï¼è¡¥å 代ç ä¸çä¸åºçèæ¯
- æ°é¡¹ç®åå§åï¼å¨å®ä¹åè½ç¹ä¹åï¼å è®°å½é¡¹ç®èæ¯
- è¿ä»£è¿ç¨ä¸ï¼éæ¶è¡¥å æ°åç°ç约ææåèèµæ
ä¿¡æ¯æ¶éå¼å¯¼
ä½¿ç¨ AskUserQuestion å¼å¯¼ç¨æ·æä¾ä¿¡æ¯ï¼
## èæ¯ä¿¡æ¯æ¶é
å½å"èæ¯ä¸ç®æ "ç« èç¶æï¼
> [æ¾ç¤ºç°æå
å®¹ï¼æ"ææ å
容"]
è¯·éæ©è¦è¡¥å
çä¿¡æ¯ç±»åï¼
1. **项ç®èæ¯** - 为ä»ä¹åè¿ä¸ªé¡¹ç®ãè§£å³ä»ä¹é®é¢
2. **é¢åç¥è¯** - å
³é®ä¸å¡æ¦å¿µãæ¯è¯è§£é
3. **ææ¯çº¦æ** - å
¼å®¹æ§è¦æ±ãæ§è½ææ ãå®å
¨è¦æ±
4. **åèèµæ** - 设计稿ãç«åãææ¡£é¾æ¥
5. **å³çè®°å½** - å
³é®ææ¯/产åéæ©ååå
ä¿¡æ¯è¾å ¥æ¹å¼
| è¾å ¥æ¹å¼ | å¤çæ¹æ³ | ç¤ºä¾ |
|---|---|---|
| ç´æ¥æè¿° | ç´æ¥æ´åå°ææ¡£ | “è¿ä¸ªé¡¹ç®æ¯ä¸ºäºæ¿æ¢æ§ç³»ç»…” |
| æä»¶è·¯å¾ | ä½¿ç¨ Read æåå ³é®ä¿¡æ¯ | “åè docs/old-design.md” |
| URL 龿¥ | ä½¿ç¨ WebFetch æåæè¦ | “åè https://example.com/spec“ |
| å¾çè·¯å¾ | è®°å½è·¯å¾ï¼æ 注ç¨é | “è®¾è®¡ç¨¿å¨ designs/v1.png” |
ææ¡£ç»ææ´æ°
èæ¯ä¿¡æ¯æ¨¡å¼ä¼æ´æ°”èæ¯ä¸ç®æ ”ç« èçç»æï¼
## 1. èæ¯ä¸ç®æ
### 1.1 项ç®èæ¯
**项ç®èµ·æº**ï¼<为ä»ä¹å¯å¨è¿ä¸ªé¡¹ç®>
**ç®æ ç¨æ·**ï¼<è°ä¼ä½¿ç¨è¿ä¸ªç³»ç»>
**æ ¸å¿é®é¢**ï¼<è§£å³ä»ä¹é®é¢>
### 1.2 é¢åç¥è¯
| æ¯è¯ | è§£é |
|------|------|
| <æ¯è¯1> | <è§£é> |
| <æ¯è¯2> | <è§£é> |
### 1.3 ææ¯çº¦æ
| 约æç±»å | 约æå
容 | åå |
|----------|----------|------|
| å
¼å®¹æ§ | 鿝æ iOS 15+ | ç¨æ·è®¾å¤åå¸ |
| æ§è½ | é¦å±å è½½ < 2s | ç¨æ·ä½éªè¦æ± |
| å®å
¨ | æ°æ®éå å¯åå¨ | åè§è¦æ± |
### 1.4 åèèµæ
| èµæ | 龿¥/è·¯å¾ | 说æ |
|------|-----------|------|
| 设计稿 | `designs/v1.fig` | Figma åå |
| ç«ååæ | `docs/competitor.md` | ç«ååè½å¯¹æ¯ |
| API ææ¡£ | https://api.example.com/docs | ç¬¬ä¸æ¹æ¥å£ |
### 1.5 å³çè®°å½
| å³ç | éæ© | åå | æ¥æ |
|------|------|------|------|
| ç¶æç®¡ç | Redux | å¢éçæï¼çææç | 2024-01-10 |
| æ°æ®åº | PostgreSQL | éè¦å¤ææ¥è¯¢æ¯æ | 2024-01-10 |
å¢éæ´æ°
èæ¯ä¿¡æ¯æ¨¡å¼æ¯æå¢éæ´æ°ï¼ä¸ä¼è¦çç°æå 容ï¼
---
## èæ¯ä¿¡æ¯æ´æ° (2024-01-20)
### æ°å¢ææ¯çº¦æ
| 约æç±»å | 约æå
容 | åå |
|----------|----------|------|
| å½é
å | 鿝æä¸è±æ | æµ·å¤å¸åºéæ± |
### æ°å¢åèèµæ
| èµæ | 龿¥/è·¯å¾ | 说æ |
|------|-----------|------|
| æ°è®¾è®¡ç¨¿ | `designs/v2.fig` | è¿ä»£çæ¬ |
约æ
åè½ç¹çº¦æ
- æ¯ä¸ªåè½ç¹å¿ é¡»æå¯ä¸ç¼å· (F-XXX)
- åè½ç¹å¿ é¡»æ æ³¨ä¼å 级 (P0/P1/P2)
- åè½ç¹æè¿°åºç®æ´æç¡®
ç¨æ·æ äºçº¦æ
- æ¯ä¸ªç¨æ·æ äºå¿ é¡»å ³èå°åè½ç¹
- å¿ é¡»éµå¾ª”ä½ä¸º…æå¸æ…以便…”æ ¼å¼
- æ¯ä¸ªåè½ç¹è³å°æ 1 ä¸ªç¨æ·æ äº
éªæ¶æ å约æ
- æ¯ä¸ªéªæ¶æ åå¿ é¡»æå¯ä¸ç¼å· (AC-XXX)
- æ¯ä¸ªç¨æ·æ äºè³å°æ 2 æ¡éªæ¶æ å
- éªæ¶æ åå¿ é¡»å¯éåãå¯éªè¯
- å¿ é¡»æè¿°éªè¯æ¹å¼
追溯约æ
- å¿ é¡»æä¾è¿½æº¯ç©éµ
- ææåè½ç¹å¿ é¡»æå¯¹åºçç¨æ·æ äº
- ææç¨æ·æ äºå¿ é¡»æå¯¹åºçéªæ¶æ å
å¢é模å¼çº¦æ
- å¿ é¡»å æ«æç°æç¼å·ï¼å»¶ç»ç¼å·
- 追å å å®¹å¿ é¡»æ æ³¨å¢éçæ¬åæ¥æ
- ä¸å¾å 餿è¦çç°æå 容
- 宿åå¿ é¡»è¿åæ°å¢ç¼å·å表
èæ¯ä¿¡æ¯æ¨¡å¼çº¦æ
- å¿ é¡»å 读åç°æ”èæ¯ä¸ç®æ ”ç« èå 容
- ä¸å¾å 餿è¦çç°æèæ¯ä¿¡æ¯
- æ°å¢å å®¹å¿ é¡»æ æ³¨æ´æ°æ¥æ
- URL å¼ç¨å¿ é¡»ä½¿ç¨ WebFetch æåæè¦ï¼ä¸è½ä» è®°å½é¾æ¥
- æä»¶å¼ç¨å¿ é¡»ä½¿ç¨ Read éªè¯æä»¶åå¨
- ææä¿¡æ¯ï¼å¯é¥ãå¯ç ãå é¨ URLï¼ä¸å¾åå ¥ææ¡£
- åèèµæå¿ é¡»æ³¨æç¨éåå ³èæ§
确认约æ
- å¿ é¡»ä¸ç¨æ·ç¡®è®¤åè½ç¹æ¯å¦å®æ´
- ä¸å¾æ·»å ç¨æ·æªæå䏿ªç¡®è®¤çåè½
Skill åä½
| åºæ¯ | åä½ Skill | 说æ |
|---|---|---|
| æ°åè½éæ± | /devdocs-feature |
被è°ç¨ï¼æ°åè½è§¦åéæ±è¿½å |
| æ´å¯è½¬å | /devdocs-insights |
被è°ç¨ï¼æ¹è¿å»ºè®®è½¬åä¸ºéæ± |
| Bug æ´é²éæ± | /devdocs-bugfix |
被è°ç¨ï¼Bug ä¿®å¤åç°éæ±ç¼ºå¤± |
| é¡¹ç®æ¹é | /devdocs-retrofit |
被è°ç¨ï¼é忍坼çæéæ± |
| æ¹é åè¡¥å èæ¯ | /devdocs-retrofit |
åç»ï¼éå宿åç¨ --context è¡¥å
èæ¯ |
| è®¾è®¡é¶æ®µ | /devdocs-system-design |
åç»ï¼éæ±ç¡®è®¤åè¿å ¥è®¾è®¡ |
| ä¸ä¸æçæ | /devdocs-onboard |
åç»ï¼èæ¯ä¿¡æ¯ä¼è¢«æåå°ä¸ä¸ææè¦ |
ä¸ä¸æ¥
| å®ææ¨¡å¼ | 建议ä¸ä¸æ¥ |
|---|---|
| åå§æ¨¡å¼ | /devdocs-system-design è¿å
¥ç³»ç»è®¾è®¡ |
| å¢éæ¨¡å¼ | /devdocs-system-design å¢é设计æ /devdocs-test-cases è¡¥å
æµè¯ |
| èæ¯ä¿¡æ¯æ¨¡å¼ | ç»§ç» /devdocs-requirements å®ä¹åè½ç¹ï¼æ /devdocs-system-design 设计 |