devdocs-dev-workflow
npx skills add https://github.com/ab300819/skills --skill devdocs-dev-workflow
Agent 安装分布
Skill 文档
å¼å工使µ
æ§è¡å个å¼åä»»å¡ç工使µæå¯¼ï¼éç¨èªé¡¶åä¸å¼å模å¼ååå± TDDã
è¯è¨è§å
- æ¯æä¸è±ææé®
- ç»ä¸ä¸æåå¤
è§¦åæ¡ä»¶
- ç¨æ·å¼å§æ§è¡æä¸ªä»»å¡ï¼å¦ T-01ï¼
- ç¨æ·éè¦å¼åæå¯¼
- ç¨æ·ä» devdocs-dev-tasks è¿å ¥å¼åé¶æ®µ
- å ³é®è¯ï¼”å¼åä»»å¡”ã”æ§è¡ä»»å¡”ã”å¼å§ T-XX”
åç½®æ¡ä»¶
- ä»»å¡ææ¡£ï¼
docs/devdocs/04-dev-tasks.md - ä»»å¡å·²å®ä¹å¹¶å å«ï¼å ³èéæ±ãéªæ¶æ åãæµè¯æ¹æ³
工使µç¨
1. 读åä»»å¡å®ä¹
âââ ä» 04-dev-tasks.md è·åä»»å¡è¯¦æ
âââ 确认å
³èç F-XXXãAC-XXX
âââ 确认å
³èçæµè¯ç¨ä¾ UT/IT/E2E-XXX
â
â¼
2. çæéª¨æ¶ä»£ç ï¼èªé¡¶åä¸ï¼
âââ æ¥å£éª¨æ¶ + @requirement/@satisfies æ æ³¨
âââ æµè¯éª¨æ¶ + @verifies/@testcase æ æ³¨
â
â¼
3. æ§è¡å¼åï¼åå± TDDï¼
âââ æ ¸å¿é»è¾ ð´ï¼æµè¯å
è¡
âââ æ¥å£å± ð¡ï¼æ¨èæµè¯å
è¡
âââ UI å± ð¢ï¼å¯å®ç°åè¡¥æµè¯
âââ åºç¡è®¾æ½ âªï¼éææµè¯éªè¯
â
â¼
4. å®ææ£æ¥
âââ åºç¡æ£æ¥ï¼å§ç»æ§è¡ï¼
â âââ éªæ¶æ åå
¨é¨æ»¡è¶³
â âââ æµè¯éè¿
â âââ Review è¦ç¹èªæ¥
â
âââ 对æå¼éªè¯ï¼ð´èªå¨è§¦å / å
¶ä»å±çº§ --review æå¨è§¦åï¼
âââ ð 代ç è´¨é审æ¥ï¼/code-quality è§è§ï¼
âââ 𧪠æµè¯å®å¤æ§å®¡æ¥ï¼/testing-guide è§è§ï¼
âââ ð 综åå®¡æ¥æ¥å
â
â¼
4.5 æ´æ°èªæè¿°ï¼/code-self-describe --updateï¼
â
â¼
5. æäº¤ä»£ç ï¼éµå¾ª /commit-conventionï¼
â
â¼
6. æ´æ°è¿½æº¯ï¼è¿è¡ /devdocs-sync --traceï¼
代ç è¿½æº¯æ æ³¨è§è
å®ç°ææ¡£â代ç çåå追溯ï¼AI å¨çæä»£ç æ¶èªå¨æ·»å æ æ³¨ã
æ æ³¨ç±»å
| æ æ³¨ | ç¨é | ä½ç½® |
|---|---|---|
@requirement F-XXX |
å ³èåè½ç¹ | æ¥å£/ç±»/模å |
@satisfies AC-XXX |
满足çéªæ¶æ å | æ¥å£/æ¹æ³ |
@verifies AC-XXX |
éªè¯çéªæ¶æ å | æµè¯ç¨ä¾ |
@testcase UT/IT/E2E-XXX |
æµè¯ç¼å· | æµè¯ç¨ä¾ |
æ æ³¨ç¤ºä¾
/**
* åå»ºç¨æ·
* @requirement F-001 - ç¨æ·æ³¨å
* @satisfies AC-001 - é®ç®±æ ¼å¼æ ¡éª
* @satisfies AC-002 - å¯ç å¼ºåº¦æ ¡éª
*/
export async function createUser(dto: CreateUserDTO): Promise<User> {
// å®ç°ä»£ç
}
/**
* @verifies AC-001 - é®ç®±æ ¼å¼æ ¡éª
* @testcase UT-001
*/
test('createUser åºè¯¥æç»æ æé®ç®±æ ¼å¼', () => {
// æµè¯ä»£ç
});
æ æ³¨è§å
| å±çº§ | æ æ³¨ä½ç½® | å¼ºå¶æ§ |
|---|---|---|
| å ¬å ±æ¥å£ | Service/API å ¥å£æ¹æ³ | å¿ é¡» |
| æµè¯æä»¶ | æ¯ä¸ªæµè¯ç¨ä¾ | å¿ é¡» |
| å é¨å®ç° | 夿é»è¾ | å¯é |
èªé¡¶åä¸å¼å模å¼
å å®ä¹éª¨æ¶ï¼åå¡«å ç»èãç¡®ä¿è¿½æº¯é¾å¨ä»£ç çææ¶å°±å»ºç«ã
å¼åæµç¨
Step 1: çææ¥å£éª¨æ¶
âââ æ¹æ³ç¾åï¼æ¥èª 02-system-design.mdï¼
âââ æ·»å @requirement/@satisfies æ æ³¨
âââ æ¹æ³ä½: throw new Error('Not implemented')
â
â¼
Step 2: çææµè¯éª¨æ¶
âââ æµè¯ç»æï¼æ¥èª 03-test-cases.mdï¼
âââ æ·»å @verifies/@testcase æ æ³¨
âââ æµè¯ä½: test.skip() æ test.todo()
â
â¼
Step 3: å®ç°æ¥å£ç»èï¼éµå¾ª /code-qualityï¼
â
â¼
Step 4: å®åæµè¯ï¼éµå¾ª /testing-guideï¼
â
â¼
Step 5: è¿è¡ /devdocs-sync --trace æ´æ°è¿½æº¯ç©éµ
骨æ¶çæçº¦æ
- æ¥å£éª¨æ¶å¿ é¡»å å«å®æ´ç¾åï¼åæ°ãè¿åå¼ãæ³åï¼
- æ¥å£éª¨æ¶å¿ 须添å è¿½æº¯æ æ³¨
- æªå®ç°æ¹æ³å¿ é¡»æåº Error 并注æä»»å¡ç¼å·
- æµè¯éª¨æ¶å¿ é¡»ä½¿ç¨ skip/todo æ è®°
- æµè¯éª¨æ¶å¿ 须添å @verifies å @testcase æ æ³¨
è¯¦è§ skeleton-examples.md
åå± TDD 模å¼
æ ¹æ®ä»»å¡ç±»åå³å®æµè¯ä¼å 级ï¼
| å±çº§ | TDD æ¨¡å¼ | 说æ |
|---|---|---|
| æ ¸å¿é»è¾ (Service/Domain) | ð´ å¼ºå¶ | æµè¯å è¡ |
| æ¥å£å± (Controller/API) | ð¡ æ¨è | 建议æµè¯å è¡ |
| UI å± (Component/View) | ð¢ å¯é | å¯å®ç°åè¡¥ |
| åºç¡è®¾æ½ (DB/Config) | ⪠ä¸éç¨ | éææµè¯éªè¯ |
TDD 循ç¯
âââââââ âââââââ âââââââ
â 红 â â â 绿 â â âéæ â âââ
âåæµè¯â âåå®ç°â âä¼å â â
â(失败)â â(éè¿)â â代ç â â
âââââââ âââââââ âââââââ â
â â
âââââââââââââââââââââââââââââ
è¯¦ç»æ§è¡æµç¨è§ execution-flow.md
Skill åä½
| é¶æ®µ | åä½ Skill | 说æ |
|---|---|---|
| åä¸å¡ä»£ç | /code-quality |
MTE ååãä¾èµæ³¨å ¥ãé¿å è¿åº¦è®¾è®¡ |
| åæµè¯ä»£ç | /testing-guide |
æè¨è´¨éãå弿µè¯ãè¦çç |
| UI å®ç° | /ui-orchestrator |
æ éç¢ãå¨ç»ãå¸å±çº¦æ |
| 宿éªè¯ | /code-quality + /testing-guide |
对æå¼éªè¯ï¼å¤è§è§å®¡æ¥ |
| å®ææ£æ¥ | /code-self-describe |
æ´æ°æ¨¡åèªæè¿°ï¼–updateï¼ |
| ä»£ç æäº¤ | /git-safety |
ä½¿ç¨ git mv/rm å¤çæä»¶ |
| æäº¤ä¿¡æ¯ | /commit-convention |
éµå¾ªé¡¹ç®æäº¤è§è |
| ä»»å¡å®æ | /devdocs-sync |
åç»ï¼æ´æ°è¿½æº¯ç©éµï¼–traceï¼ |
约æ
骨æ¶çæçº¦æ
- æ¥å£éª¨æ¶å¿ é¡»å å«å®æ´ç¾å
- æ¥å£éª¨æ¶å¿ 须添å è¿½æº¯æ æ³¨
- æªå®ç°æ¹æ³å¿ é¡»æåº Error
- æµè¯éª¨æ¶å¿ é¡»ä½¿ç¨ skip/todo æ è®°
- æµè¯éª¨æ¶å¿ 须添å @verifies å @testcase æ æ³¨
åå± TDD 约æ
- æ ¸å¿é»è¾ä»»å¡å¿ é¡»æ è®° ð´ å¼ºå¶ TDD
- æ ¸å¿é»è¾ä»»å¡å¿ é¡»å åæµè¯ï¼ååå®ç°
- æ ¸å¿é»è¾ä»»å¡ç¦æ¢å¨æµè¯éè¿åæäº¤
- æ¥å£å±ä»»å¡æ è®° ð¡ æ¨è TDD
- UI å±ä»»å¡æ è®° ð¢ å¯é TDD
- åºç¡è®¾æ½ä»»å¡æ è®° ⪠ä¸éç¨ TDD
- TDD ä»»å¡å¿ é¡»å å«çº¢-绿-éæä¸æ¥éª¤
å®ææ£æ¥çº¦æ
- éªæ¶æ å (AC-XXX) å ¨é¨æ»¡è¶³
- å ³èæµè¯å ¨é¨éè¿
- Review è¦ç¹èªæ¥å®æ
- 代ç è¿½æº¯æ æ³¨å®æ´
- 代ç 忝è¦çåæå®æï¼å¯éï¼ä½¿ç¨
/testing-guide忝åæï¼
对æå¼éªè¯ï¼å¯éï¼
以ä¸åè§è²è§è§å®¡æ¥ä»£ç ï¼æ¨¡æ “å¼å â å®¡æ¥ â æµè¯” çå¤äººå使¨¡å¼ã æ ¸å¿é»è¾ä»»å¡ï¼ð´ï¼èªå¨è§¦åï¼å ¶ä»å±çº§éè¿
--reviewæå¨è§¦åã
è§¦åæ¡ä»¶
å±çº§å¤å®ï¼ä»»å¡å±çº§æ è®°ï¼ð´ð¡ð¢âªï¼æ¥èª
04-dev-tasks.mdä¸çä»»å¡å®ä¹ï¼ç±/devdocs-dev-taskså¨ä»»å¡æåæ¶æ ¹æ®ä»»å¡åå±è§ååé ã
| ä»»å¡å±çº§ | é»è®¤è¡ä¸º | æå¨æ§å¶ |
|---|---|---|
| ð´ æ ¸å¿é»è¾ | èªå¨è§¦å | --skip-review è·³è¿ |
| ð¡ æ¥å£å± | ä¸è§¦å | --review å¯ç¨ |
| ð¢ UI å± | ä¸è§¦å | --review å¯ç¨ |
| ⪠åºç¡è®¾æ½ | ä¸è§¦å | --review å¯ç¨ |
éªè¯æµç¨
åºç¡å®ææ£æ¥ï¼å§ç»æ§è¡ï¼
â
âââ AC å
¨é¨æ»¡è¶³ â
âââ æµè¯å
¨é¨éè¿ â
âââ ä»£ç æ æ³¨å®æ´ â
â
â¼ ï¼å¯¹æå¼éªè¯è§¦åæ¶ï¼
Phase 1: 代ç è´¨éå®¡æ¥ ð
âââ åæ¢å° /code-quality è§è§
âââ MTE å忣æ¥ï¼å½æ°é¿åº¦/åæ°/åµå¥/èè´£ï¼
âââ ä¾èµæ¹åæ£æ¥
âââ å®å
¨æ£æ¥
âââ è¾åº: é®é¢å表ï¼Blocker/Suggestionï¼
â
â¼
Phase 2: æµè¯å®å¤æ§å®¡æ¥ ð§ª
âââ åæ¢å° /testing-guide è§è§
âââ æè¨è´¨éæ£æ¥ï¼ç¦æ¢å¼±æè¨ï¼
âââ è¦ççæ£æ¥ï¼è¡/忝 â¥80%ï¼
âââ éæ±è¿½æº¯æ£æ¥ï¼AC å
¨è¦çï¼
âââ [å¯é] 代ç 忝è¦çåæ
âââ è¾åº: é®é¢å表ï¼Blocker/Suggestionï¼
â
â¼
Phase 3: 综åå®¡æ¥æ¥å ð
âââ æ±æ»ææé®é¢
âââ ð« Blocker â å¿
须修å¤åéæ°éªè¯
âââ ð¡ Suggestion â 询é®ç¨æ·æ¯å¦ä¿®å¤
审æ¥ç»æå级
| çº§å« | æ è®° | å¤ç |
|---|---|---|
| ð« Blocker | å¿ é¡»ä¿®å¤ | 黿¢æäº¤ï¼ä¿®å¤åéæ°éªè¯ |
| ð¡ Suggestion | å»ºè®®ä¿®å¤ | 询é®ç¨æ·ï¼å¯éæ©å¿½ç¥ |
对æå¼éªè¯çº¦æ
- Blocker é®é¢å¿ 须修å¤åæè½æäº¤
- æ¯ä¸ª Phase å¿ é¡»æç¡®å£°æå½å审æ¥è§è²
- 审æ¥ç»æå¿ é¡»å级ï¼Blocker/Suggestionï¼
- æ ¸å¿é»è¾ä»»å¡ï¼ð´ï¼é»è®¤è§¦å
- ä¿®å¤ Blocker åå¿ é¡»éæ°è¿è¡éªè¯
详ç»å®¡æ¥æ¸ å忥忍¡æ¿è§ verification-flow.md
ä»»å¡å®ææµç¨
TDD ä»»å¡ï¼æ ¸å¿é»è¾ ð´ï¼
- 确认æµè¯å è¡ï¼æ£æ¥æ¯å¦å åäºæµè¯
- 确认红-绿循ç¯ï¼æµè¯ä»å¤±è´¥å°éè¿
- æ£æ¥éæï¼ä»£ç æ¯å¦ç»è¿ä¼å
- éªè¯éªæ¶æ åï¼æ£æ¥ææ AC æ¯å¦æ»¡è¶³
- 对æå¼éªè¯ï¼èªå¨è§¦åï¼ï¼
- Phase 1: 代ç è´¨é审æ¥ï¼/code-quality è§è§ï¼
- Phase 2: æµè¯å®å¤æ§å®¡æ¥ï¼/testing-guide è§è§ï¼
- Phase 3: ç»¼åæ¥åï¼å¤ç Blocker
- æ´æ°èªæè¿°ï¼è¿è¡ /code-self-describe –update
- è¯¢é®æäº¤ï¼ä½¿ç¨ AskUserQuestion 询é®ï¼
- “ä»»å¡ T-XXï¼TDDï¼å·²å®æï¼æµè¯éè¿ï¼æ¯å¦æäº¤ä»£ç ï¼”
- é项4æäº¤” / “ç»§ç»ä¿®æ¹” / “跳返
- å¦æäº¤ï¼æ§è¡ git add å commitï¼æ¶æ¯å å«ä»»å¡ç¼å·
- æ´æ°ç¶æï¼å°ä»»å¡æ è®°ä¸ºå·²å®æ
é TDD ä»»å¡ï¼æ¥å£/UI/åºç¡è®¾æ½ï¼
- æ§è¡æµè¯ï¼è¿è¡ä»»å¡å®ä¹çæµè¯æ¹æ³
- éªè¯éªæ¶æ åï¼æ£æ¥ææéªæ¶æ 忝妿»¡è¶³
- 对æå¼éªè¯ï¼å¦ –review 触åï¼ï¼åä¸ Phase 1-3
- èªæ¥ Review è¦ç¹ï¼æ£æ¥ä»£ç 审æ¥è¦ç¹
- è¯¢é®æäº¤ï¼ä½¿ç¨ AskUserQuestion 询é®
- å¦æäº¤ï¼æ§è¡ git add å commit
- æ´æ°ç¶æï¼å°ä»»å¡æ è®°ä¸ºå·²å®æ
æäº¤ä¿¡æ¯æ ¼å¼
éµå¾ª /commit-convention è§èï¼æ ¼å¼å¦ä¸ï¼
<type>(T-XX): <ä»»å¡åç§°>
- <宿å
容1>
- <宿å
容2>
å
³è: F-XXX, AC-XXX
æµè¯: UT-XXX, IT-XXX éè¿
type ç±»åï¼feat | fix | refactor | test | docs | chore
åèèµæ
- skeleton-examples.md – æ¥å£/æµè¯éª¨æ¶ç¤ºä¾
- execution-flow.md – 任塿§è¡æµç¨è¯¦è§£
- verification-flow.md – 对æå¼éªè¯æµç¨è¯¦è§£