devdocs-feature
npx skills add https://github.com/ab300819/skills --skill devdocs-feature
Agent 安装分布
Skill 文档
æ°åè½
å¨å·²æ DevDocs 项ç®ä¸è¿½å æ°åè½ï¼ç¡®ä¿ç¼å·å»¶ç»ãææ¡£ä¸è´ã
è¯è¨è§å
- æ¯æä¸è±ææé®
- ç»ä¸ä¸æåå¤
è§¦åæ¡ä»¶
- ç¨æ·è¦å¨å·²æé¡¹ç®ä¸æ·»å æ°åè½
- ç¨æ·æå°”å¢é”ã”è¿ä»£”ã”æ°å¢åè½”ã”追å éæ±”
- ç¨æ·è¦æ±æ©å±ç°æåè½
åç½®æ¡ä»¶
- å·²åå¨ DevDocs ææ¡£ç®å½ï¼
docs/devdocs/ - è³å°åå¨
01-requirements.md
å¦ä¸åå¨ï¼å»ºè®®ï¼
- æ°é¡¹ç® â
/devdocs-requirements - å·²æä»£ç æ ææ¡£ â
/devdocs-retrofit
è¿è¡æ¨¡å¼
模å¼éæ©
/devdocs-feature "åè½æè¿°" â èªå¨æ£æµæ¨¡å¼
/devdocs-feature --lite "åè½æè¿°" â 强å¶è½»é模å¼
模å¼å¯¹æ¯
| æ¨¡å¼ | éç¨åºæ¯ | æ´æ°ææ¡£ | ä¸ä¸æè´è½½ |
|---|---|---|---|
| è½»éæ¨¡å¼ | é 置修æ¹ãUI å¾®è°ãç®ååæ®µ | 01 + 04 | ä½ |
| 宿´æ¨¡å¼ | æ°æ¨¡åãæ°æ¥å£ãæ¶æåæ´ | 01 + 02 + 03 + 04 | é«ï¼åæ¥ï¼ |
èªå¨æ¨¡å¼æ£æµ
åæéæ±æè¿°ï¼æ£æµæ¯å¦æ¶åï¼
[ ] æ°å¢ API æ¥å£
[ ] æ°æ®æ¨¡ååæ´
[ ] ç»ä»¶é´ä¾èµåå
[ ] ç¬¬ä¸æ¹æå¡éæ
[ ] æ°å¢ç¬ç«æ¨¡å
- 以ä¸åæ â è½»éæ¨¡å¼
- ä»»ä¸å½ä¸ â 宿´æ¨¡å¼ï¼æç¤ºç¨æ·ç¡®è®¤ï¼
æ£æµå°å¯è½æ¶åæ¶æåæ´ï¼
- æ°å¢æ¥å£: UserPreferenceAPI
建议使ç¨å®æ´æ¨¡å¼ãæ¯å¦ç»§ç»è½»é模å¼ï¼[æ¯/å¦]
æ ¸å¿ç念
æ°åè½å¼å = å»¶ç»ç¼å· + è¿½å ææ¡£ + å½±ååæ + åå½ä¿æ¤
è½»éæ¨¡å¼æµç¨ (–lite)
1. æ«æç¼å·
â
âââ 读å 01-requirements.md â è·å AC æå¤§ç¼å·
âââ 读å 04-dev-tasks*.md â è·å T æå¤§ç¼å·
â
â¼
2. æ¶ééæ±ï¼ç®åï¼
â
âââ éªæ¶æ åï¼AC 级å«ï¼
â
â¼
3. è¿½å ææ¡£ï¼ä»
两份ï¼
â
âââ 01-requirements.md â 追å ACï¼æè½½å°ç°æ F/USï¼
âââ 04-dev-tasks*.md â 追å 1-3 个任å¡
â
â¼
4. ç¨æ·ç¡®è®¤
è½»éæ¨¡å¼çº¦æ
- 䏿°å»º F-XXXï¼åè½ç¹ï¼ï¼ä» 追å AC å°ç°æåè½
- 䏿´æ° 02-system-designï¼æ æ¶æåæ´ï¼
- 䏿´æ° 03-test-casesï¼ç±
/devdocs-syncåç»è¡¥é½ï¼ - 任塿°ééå¶ 1-3 个ï¼å¯ç´æ¥è¿½å ï¼æ éè°ç¨ devdocs-dev-tasksï¼
- ä»»å¡å¿ é¡»éµå¾ª TAR ååæ ¼å¼
宿´æ¨¡å¼æµç¨ï¼åæ¥ç¼æï¼
æ ¸å¿åæ´ï¼ä¸å䏿¬¡æ§æ´æ° 4 ä»½ææ¡£ï¼èæ¯åæ¥æ§è¡ï¼æ¯æ¥ç¡®è®¤ååè¿å ¥ä¸ä¸æ¥ã
âââââââââââââââââââââââââââââââââââââââââââââââââââââââââââââââ
â Step 0: æ«æç°æææ¡£ï¼è·åç¼å·åæ¶ææè¦ â
âââââââââââââââââââââââââââââââââââââââââââââââââââââââââââââââ
â
â¼
âââââââââââââââââââââââââââââââââââââââââââââââââââââââââââââââ
â Step 1: éæ±è¿½å â
â âââ æ¶éæ°åè½æè¿° â
â âââ 追å 01-requirements.mdï¼F/US/ACï¼ â
â âââ â
ç¨æ·ç¡®è®¤ â
âââââââââââââââââââââââââââââââââââââââââââââââââââââââââââââââ
â
â¼
âââââââââââââââââââââââââââââââââââââââââââââââââââââââââââââââ
â Step 2: 设计追å â
â âââ å½±ååæï¼æ¨¡å/æ¥å£/æ°æ®ï¼ â
â âââ 追å 02-system-design*.md â
â âââ â
ç¨æ·ç¡®è®¤ â
âââââââââââââââââââââââââââââââââââââââââââââââââââââââââââââââ
â
â¼
âââââââââââââââââââââââââââââââââââââââââââââââââââââââââââââââ
â Step 3: æµè¯è¿½å â
â âââ æ ¹æ®æ°å¢ AC 设计æµè¯ç¨ä¾ â
â âââ 追å 03-test-cases*.md + æ´æ°è¿½æº¯ç©éµ â
â âââ â
ç¨æ·ç¡®è®¤ â
âââââââââââââââââââââââââââââââââââââââââââââââââââââââââââââââ
â
â¼
âââââââââââââââââââââââââââââââââââââââââââââââââââââââââââââââ
â Step 4: ä»»å¡è¿½å â
â âââ æ ¹æ®è®¾è®¡åæµè¯æåå¼åä»»å¡ â
â âââ 追å 04-dev-tasks*.md â
â âââ â
ç¨æ·ç¡®è®¤ â
âââââââââââââââââââââââââââââââââââââââââââââââââââââââââââââââ
â
â¼
âââââââââââââââââââââââââââââââââââââââââââââââââââââââââââââââ
â Step 5: çæåè½æ¥å¿ â
â âââ æ´æ° 00-feature-log.md â
âââââââââââââââââââââââââââââââââââââââââââââââââââââââââââââââ
忥æ§è¡ä¼å¿
| é®é¢ | ä¼ ç»æ¹å¼ | åæ¥ç¼æ |
|---|---|---|
| ç¼å·éå¤ | 䏿¬¡ç»´æ¤ 4 份ç¼å·ï¼æåºé | æ¯æ¥åªå ³æ³¨å½åææ¡£ç¼å· |
| æ¼æ´æ° | ä¸ä¸æè¿é¿ï¼æéæ¼ | æ¯æ¥ç¡®è®¤ï¼ä¸éæ¼ |
| 追溯ä¸å®æ´ | é¾ä»¥ä¿è¯ ACâæµè¯ å®æ´æ§ | Step 3 䏿³¨è¿½æº¯ç©éµ |
| åæ»å°é¾ | å ¨éä¿®æ¹é¾åæ» | å¯å¨ä»»ææ¥éª¤ç»æ¢ |
Step 0: æ«æç°æææ¡£
ç¼å·æå
ä»ç°æææ¡£ä¸æåæå¤§ç¼å·ï¼
## å½åç¶æ
| ç±»å | å½åæå¤§ç¼å· | ä¸ä¸ç¼å· |
|------|-------------|----------|
| åè½ç¹ (F) | F-003 | F-004 |
| ç¨æ·æ
äº (US) | US-008 | US-009 |
| éªæ¶æ å (AC) | AC-015 | AC-016 |
| åå
æµè¯ (UT) | UT-012 | UT-013 |
| éææµè¯ (IT) | IT-003 | IT-004 |
| E2E æµè¯ (E2E) | E2E-002 | E2E-003 |
| å¼åä»»å¡ (T) | T-10 | T-11 |
æ¶ææè¦ï¼å®æ´æ¨¡å¼ï¼
ä» 02-system-design*.md æåï¼
- ç°ææ¨¡åå表
- æ ¸å¿æ¥å£
- æ°æ®å®ä½
Step 1: éæ±è¿½å
å§ææ§è¡ï¼æ¬æ¥éª¤å¿ 须姿ç»
/devdocs-requirements --incrementalï¼ç±å ¶è´è´£å¢ééæ±ã
å§æè¾å ¥
ä¼ éç» /devdocs-requirements çä¸ä¸æï¼
- ç¨æ·çæ°åè½æè¿°
- Step 0 æ«æå°çç°æç¼å·ç¶æ
å§æè¾åº
ä» /devdocs-requirements è·åï¼
- æ°å¢ç F-XXXãUS-XXXãAC-XXX ç¼å·å表
- æ´æ°åç追溯ç©éµ
â 确认ç¹
/devdocs-requirements å·²å®æéæ±è¿½å ï¼
- [æ°å¢ç¼å·æè¦ç± requirements è¿å]
æ¯å¦ç¡®è®¤å¹¶ç»§ç»å° Step 2ï¼è®¾è®¡è¿½å ï¼ï¼[确认/ä¿®æ¹/ç»æ¢]
Step 2: 设计追å ï¼å®æ´æ¨¡å¼ï¼
å§ææ§è¡ï¼æ¬æ¥éª¤å¿ 须姿ç»
/devdocs-system-designï¼ç±å ¶è´è´£å¢é设计ã
å§æè¾å ¥
ä¼ éç» /devdocs-system-design çä¸ä¸æï¼
- Step 1 æ°å¢ç F-XXXãUS-XXXãAC-XXX ç¼å·
- ç°ææ¶ææè¦ï¼æ¥èª Step 0ï¼
- å½±ååæé®é¢æ¸ å
å§æè¾åº
ä» /devdocs-system-design è·åï¼
- æ°å¢/åæ´çæ¨¡å忥å£
- å½±åæè¦
- åå½é£é©ç¹
â 确认ç¹
/devdocs-system-design å·²å®æè®¾è®¡è¿½å ï¼
- [è®¾è®¡åæ´æè¦ç± system-design è¿å]
æ¯å¦ç¡®è®¤å¹¶ç»§ç»å° Step 3ï¼æµè¯è¿½å ï¼ï¼[确认/ä¿®æ¹/ç»æ¢]
Step 3: æµè¯è¿½å ï¼å®æ´æ¨¡å¼ï¼
å§ææ§è¡ï¼æ¬æ¥éª¤å¿ 须姿ç»
/devdocs-test-casesï¼ç±å ¶è´è´£å¢éæµè¯è®¾è®¡ã
å§æè¾å ¥
ä¼ éç» /devdocs-test-cases çä¸ä¸æï¼
- Step 1 æ°å¢ç AC-XXX ç¼å·
- Step 2 æ°å¢çæ¥å£å模åï¼æ¥èª system-designï¼
å§æè¾åº
ä» /devdocs-test-cases è·åï¼
- æ°å¢ç UT/IT/E2E-XXX ç¼å·
- æ´æ°åç追溯ç©éµ
â 确认ç¹
/devdocs-test-cases 已宿æµè¯è¿½å ï¼
- [æµè¯ç¼å·æè¦ç± test-cases è¿å]
- 追溯ç©éµå·²æ´æ°
æ¯å¦ç¡®è®¤å¹¶ç»§ç»å° Step 4ï¼ä»»å¡è¿½å ï¼ï¼[确认/ä¿®æ¹/ç»æ¢]
Step 4: ä»»å¡è¿½å
è°ç¨ devdocs-dev-tasks
éè¦ï¼å®æ´æ¨¡å¼ä¸ï¼ä»»å¡æåç±
/devdocs-dev-tasksè´è´£ï¼ç¡®ä¿ TAR ååååå± TDD æ è®°çä¸è´æ§ã
ä¼ éç» devdocs-dev-tasks çä¸ä¸æï¼
- æ°å¢ç F-XXXãAC-XXX ç¼å·
- æ°å¢ç UT/IT/E2E-XXX ç¼å·
- å½±åçæ¨¡å忥å£
è°ç¨ /devdocs-dev-tasksï¼
- è¾å
¥ï¼Step 1-3 产ççæ°å¢ç¼å·
- è¾åºï¼è¿½å å° 04-dev-tasks*.md
- éµå¾ªï¼TAR ååãåå± TDD
â 确认ç¹
/devdocs-dev-tasks 已追å ä»»å¡ï¼
- æ°å¢ T-XX ~ T-XXï¼N 个任å¡ï¼
- å·²æ æ³¨ TDD åå±ï¼ð´ð¡ð¢âªï¼
æ¯å¦ç¡®è®¤å¹¶çæåè½æ¥å¿ï¼[确认/ä¿®æ¹/ç»æ¢]
Step 5: çæåè½æ¥å¿
è¾åºæä»¶
docs/devdocs/
âââ 00-feature-log.md # åè½æ¥å¿ï¼è¿½å ï¼
æ¥å模æ¿
# æ°åè½å¼åæ¥å¿
## v2: <åè½åç§°> (2024-01-15)
### æ°å¢å
容
| ç±»å | ç¼å· | æè¿° |
|------|------|------|
| åè½ç¹ | F-004 | <æè¿°> |
| ç¨æ·æ
äº | US-009, US-010 | <æè¿°> |
| éªæ¶æ å | AC-016 ~ AC-020 | 5 æ¡ |
| æµè¯ç¨ä¾ | UT-013 ~ UT-015, E2E-003 | 4 æ¡ |
| å¼åä»»å¡ | T-11 ~ T-14 | 4 个 |
### å½±åèå´
- æ°å¢æ¨¡åï¼PaymentModule
- ä¿®æ¹æ¥å£ï¼IOrderService
- åå½é£é©ï¼OrderService æµè¯
### å
³èææ¡£
- [01-requirements.md](01-requirements.md) - å·²æ´æ°
- [02-system-design.md](02-system-design.md) - å·²æ´æ°
- [03-test-cases.md](03-test-cases.md) - å·²æ´æ°
- [04-dev-tasks.md](04-dev-tasks.md) - å·²æ´æ°
---
## v1: åå§çæ¬ (2024-01-01)
...
Skill åä½
| é¶æ®µ | åä½ Skill | 说æ |
|---|---|---|
| éæ±è¿½å | /devdocs-requirements |
宿´æ¨¡å¼å¿ 须姿ï¼å¢éæ´æ°ï¼ |
| 设计追å | /devdocs-system-design |
宿´æ¨¡å¼å¿ 须姿ï¼å¢éæ´æ°ï¼ |
| æµè¯è¿½å | /devdocs-test-cases |
宿´æ¨¡å¼å¿ 须姿ï¼å¢éæ´æ° + ç©éµï¼ |
| ä»»å¡è¿½å | /devdocs-dev-tasks |
宿´æ¨¡å¼å¿ 须姿 |
| å¼åå®ç° | /devdocs-dev-workflow |
æ§è¡åä¸ªä»»å¡ |
| ç¼ç 约æ | /code-quality, /testing-guide |
ç¼ç é¶æ®µ |
ç¼æå¨è¾¹çï¼
devdocs-featureæ¯çº¯ç¼æå¨ï¼è´è´£æ¥éª¤ç¼æã确认æµç¨ãåè½æ¥å¿ã å ·ä½çéæ±ãè®¾è®¡ãæµè¯ãä»»å¡å å®¹å ¨é¨ç±å¯¹åºçä¸é¡¹ Skill è´è´£ï¼æ¬ Skill ä¸å¤å¶å ¶é»è¾ã
约æ
ç¼å·çº¦æ
- å¿ é¡»å»¶ç»ç°æç¼å·ï¼ä¸å¾éå¤
- å¿ é¡»å æ«æç°æææ¡£è·åæå¤§ç¼å·
- ç¼å·æ ¼å¼ä¿æä¸è´ï¼F-XXX, US-XXX, AC-XXXï¼
ææ¡£çº¦æ
- 追å å å®¹å¿ é¡»æ æ³¨åè½çæ¬åæ¥æ
- ä¸å¾å 餿è¦çç°æå 容
- 追å ä½ç½®å¿ é¡»æ£ç¡®ï¼ç« èæ«å°¾ï¼
- æ ¼å¼å¿ é¡»ä¸ç°æææ¡£ä¸è´
åæ¥ç¼æçº¦æï¼å®æ´æ¨¡å¼ï¼
- æ¯æ¥å®æåå¿ é¡»çå¾ ç¨æ·ç¡®è®¤
- ä¸å¾è·³è¿æ¥éª¤ï¼é¤éç¨æ·æç¡®è¦æ±ï¼
- ç¨æ·å¯å¨ä»»ææ¥éª¤éæ©”ç»æ¢”
- æ¯æ¥åªå ³æ³¨å½åææ¡£çç¼å·åæ ¼å¼
- æ¥éª¤é´ä¼ éçä¿¡æ¯ä» éï¼æ°å¢ç¼å·å表
è½»éæ¨¡å¼çº¦æ
- ä» æ´æ° 01-requirements.md å 04-dev-tasks.md
- 䏿°å»º F-XXXï¼ä» 追å AC å°ç°æåè½
- 任塿°ééå¶ 1-3 个
- æ£æµå°æ¶æå½±åæ¶å¿ é¡»æç¤ºç¨æ·
å½±ååæçº¦æ
- ä¿®æ¹ç°ææ¥å£å¿ 须说æååå ¼å®¹æ§
- å¿ é¡»ååºåå½é£é©ç¹
- é«å½±ååæ´éç¨æ·ç¡®è®¤
追溯约æï¼å®æ´æ¨¡å¼ï¼
- æ°å¢ F-XXX å¿ é¡»æå¯¹åº US-XXX å AC-XXX
- æ°å¢ AC-XXX å¿ é¡»æå¯¹åºæµè¯ç¨ä¾
- å¿ é¡»æ´æ°è¿½æº¯ç©éµ
ç¹æ®æ åµ
ææ¡£ç»æä¸å®æ´
å¦æåªæé¨åææ¡£åå¨ï¼
1. æç¤ºç¨æ·ç¼ºå¤±çææ¡£
2. 建议å
è¡¥å
¨ææ¡£ï¼ä½¿ç¨ /devdocs-retrofitï¼
3. æä»
追å å°å·²æææ¡£
å¤§è§æ¨¡åè½
妿æ°åè½éæ±è¾å¤§ï¼è¶ è¿ 3 个åè½ç¹ï¼ï¼
建议æåä¸ºå¤æ¬¡è¿ä»£ï¼
1. æåè½æ¨¡åæå
2. æ¯æ¬¡è¿ä»£ç¬ç«å®æ
3. åå«æäº¤åéªè¯
鿱忴ï¼éæ°å¢ï¼
妿æ¯ä¿®æ¹ç°æéæ±èéæ°å¢ï¼
â ï¸ è¿æ¯éæ±åæ´ï¼ä¸æ¯æ°åè½éæ±ã
建议ï¼
1. å¨å F-XXX 䏿 æ³¨åæ´
2. æ´æ°ç¸å
³ US/AC
3. æ´æ°åå½±åçæµè¯ç¨ä¾
4. è®°å½åæ´åå
è¾åº
- æ´æ°
01-requirements.mdï¼è¿½å ï¼ - æ´æ°
02-system-design*.mdï¼è¿½å /ä¿®æ¹ï¼ - æ´æ°
03-test-*.mdï¼è¿½å ï¼ - æ´æ°
04-dev-tasks*.mdï¼è¿½å ï¼ - æ´æ°/å建
00-feature-log.mdï¼è¿½å ï¼