spec-plan
1
总安装量
1
周安装量
#41464
全站排名
安装命令
npx skills add https://github.com/junhualiu1/awesome-skills --skill spec-plan
Agent 安装分布
claude-code
1
antigravity
1
Skill 文档
Spec-Plan Workflow (Spec-driven)
è¾åºç©ï¼å¼ºå¶ï¼
- ä»
ä¸ä¸ªæä»¶ï¼
docs/specs/spec{n}_<slug>.md - ä» ä¸æ¬¡æäº¤ï¼åªæäº¤è¯¥ specï¼ä¸çæ designãä¸é¢å¤ commitï¼
0) 建ç«ä»åºä¸ä¸æï¼å¿ é¡»åï¼
卿é®åå å¿«éæ«ä¸éï¼åå°æ æé®é¢ï¼ï¼
- ç®å½ï¼
README*,docs/,src/,packages/,configs/ - æ¯å¦å·²æ
docs/specs/ä¸å½åè§å/模ç git log -n 20 --onelineäºè§£è¿ææ¹åä¸çº¦æ- åºæ¬çº¦å®ï¼API 飿 ¼/é ç½®æ¹å¼/CI 鍿§ï¼ç¥éâæä¹è·âå³å¯ï¼
è¥æ æ³è®¿é®ä»åºï¼æç¡®è¯´æâ缺å°ä»åºä¸ä¸æâï¼è¯·ç¨æ·ç²è´´ç®å½æ /ç¸å ³æ¨¡å/ç°ææ¥å£ç¤ºä¾ï¼åæ¶ç»§ç»æ¨è¿ï¼ä½¿ç¨
TBDæ æ³¨ä¸ç¡®å®é¡¹ã
æé®è§åï¼å¼ºå¶ï¼
- åªé® å ³é® / æ ¸å¿ / ææ§ä¹ çé®é¢ï¼ä¼å½±åå®ç°è·¯å¾ãèå´ææ¥å£ï¼
- åç»æé®æ¹å¼ï¼æ¯è½®æå¤é® 3 个ãæå
³é®ãæé»å¡ãçé®é¢ï¼ç¨æ·åçåï¼æ¨¡åå¿
é¡»å
ç¨ 2â4 å¥å¤è¿°ï¼
- â 已确认çä¿¡æ¯
- â ï¸ ä»å¾ æç¡®ï¼TBDï¼çå ³é®ç¹
- å¨å®æå¤è¿°åï¼æ¨¡åå¿
é¡»è¿è¡ä¸æ¬¡ å
³é®æ§ä¹èªæ£ï¼
- 夿å½åä¿¡æ¯æ¯å¦ä»åå¨ ä¼å½±åå®ç°è·¯å¾ãèå´ææ¥å£çå ³é®ä¸ç¡®å®æ§
- è¥ åå¨ï¼è¿å ¥ä¸ä¸è½®ç»§ç»è¿½é®ï¼ä»éµå¾ªæ¯è½®æå¤ 3 个çé®é¢éå¶ï¼
- è¥ ä¸åå¨ï¼ç«å³åæ¢æé®å¹¶è¿å ¥ä¸ä¸é¶æ®µ
- å ¨ç¨ä¸¥æ ¼å»éä¸åå¹¶ç¸è¿é®é¢ï¼ç´¯è®¡é®é¢æ»æ° ä¸è¶ è¿ 10 个ï¼ç¡®ä¿èç¦èä¸åæ£
- é®é¢ä¼å
éç¨ å¤éå½¢å¼ï¼å¹¶æä¾
Other / ä¸ç¡®å®
ä½ å¿ é¡»ä¼å ææ¸ çç¹ï¼ä»ä¸å¾ä¸é®ï¼
- ç¨æ·/åºæ¯ï¼è°ç¨ï¼ä½æ¶è§¦åï¼ç°å¨æä¹åï¼æå¤§çç¹ï¼
- æåæ åï¼ææ ·ç®æåï¼éªæ¶å£å¾æ¯ä»ä¹ï¼
- èå´è¾¹çï¼å¿ é¡»å/ä¸å/å¯éï¼YAGNIï¼å¯éæ¾ Future Workï¼
- è¾å ¥è¾åºï¼UI/API/CLI/é ç½®/ä»»å¡ï¼å¯¹å¤å¥çº¦æ¯ä»ä¹ï¼
- 约æï¼å ¼å®¹æ§/æ§è½/æé/åè§/ä¾èµç³»ç»/ä¸çº¿çªå£
- é£é©ï¼å¤±è´¥ç¹ãåæ»è¦æ±ãæ°æ®ä¸è´æ§è¦æ±
2) æ¹æ¡æ¶æï¼å¿ é¡»ç» 2-3 个ï¼
å½ä¿¡æ¯å¤ç¨æ¶ï¼ç»åº 2-3 ä¸ªæ¹æ¡ï¼å¹¶æç¡®æ¨èæ¹æ¡ã æ¯ä¸ªæ¹æ¡å å«ï¼
- éç¨åæ
- ä¼ç¹
- 缺ç¹/é£é©
- å¤æåº¦ï¼ä½/ä¸/é«ï¼
- 影忍¡å/å¤§æ¦æ¹å¨ç¹
- Future Workï¼æç¡®è¿æ¬¡ä¸åçï¼
æ¨èæ¹æ¡å¿ 须解éâ为ä½å¨å½å约æä¸æåéâï¼é¿å è¿åº¦è®¾è®¡ã
3) Spec åä½ï¼å¯è¯å®¡ãå¯å®æ½ï¼
Spec å¿ é¡»å ·å¤
- å¯å®ç°ï¼æ¨¡åæ¹å¨ç¹ãæ¥å£å¥çº¦ãæ°æ®ç»æãè¾¹çæ¡ä»¶
- å¯éªæ¶ï¼Acceptance Criteriaï¼å¯¹é½ FR/NFRï¼
- å¯åå¸ï¼ä¸çº¿/è¿ç§»/åæ»/å ¼å®¹çç¥
- ä¸ç¡®å®é¡¹ï¼æ£ææ
TBDï¼æ«å°¾Open Questionsæ±æ»
Spec ç»æï¼ç²¾ç®çï¼
- Backgroundï¼çç¹ä¸ç°ç¶ï¼
- Goals / Non-goalsï¼é²æ¢èå´è¨èï¼
- Use Casesï¼å ³é®ç¨æ·è·¯å¾ï¼
- Requirementsï¼FR / NFRï¼æå°å¿ è¦ï¼
- Proposed Solutionï¼æ¨èæ¹æ¡ + å ³é®å³ç + å¤éæ¹æ¡ç®è¿°ï¼
- Architecture & Data Flowï¼æµç¨/æ¶åº/è¾¹çï¼
- Interfaces / Data Modelï¼å¦éç¨ï¼APIãäºä»¶ãåå¨åæ´ï¼
- Error Handling & Edge Casesï¼å¹ç/éè¯/é级/ä¸è´æ§ï¼
- Rollout / Migration / Rollbackï¼åå¸ä¸åéï¼
- Work Breakdownï¼æé¡ºåºçä»»å¡æè§£ + Done Definitionï¼
- Testing Notesï¼å ³é®ç¨ä¾ä¸è¦çèå´è¯´æï¼
- Acceptance Criteriaï¼Checklistï¼
- Open Questionsï¼æ±æ» TBDï¼
- Future Workï¼å¯éï¼
4) è½çè§åï¼å¼ºå¶ï¼
ç®å½ä¸ç¼å·
- ç®å½ï¼
docs/specs/ï¼ä¸åå¨ååå»ºï¼ - ç¼å·èªå¢ï¼
- æ«æ
docs/specs/ä¸å¹é spec(\d+)_çæä»¶ n = max_n + 1ï¼è¥æ ån = 1
- æ«æ
æä»¶å slugï¼snake_caseï¼
- æä»¶åï¼
spec{n}_<slug>.md - è§åï¼å°åï¼ç©ºæ ¼/è¿å符â
_ï¼å»ç¹æ®å符ï¼åå¹¶è¿ç»_ - 䏿䏻é¢ï¼ä¼å ç®çè±æ/æ¼é³ï¼å¦åç¨è¯ä¹æ¸ æ°è±æå åº
5) å¯ä¸ä¸æ¬¡æäº¤ï¼å¼ºå¶ï¼
å®æå¹¶ç¡®è®¤ spec åï¼
git status --porcelainç¡®è®¤åæ´git add docs/specs/spec{n}_<slug>.mdgit commit -m "docs: add spec{n} <slug>"ï¼è¥ä»åºæè§èåéµå¾ªï¼
对è¯ä¸å¿ é¡»è¿åï¼
- spec æä»¶è·¯å¾
- Spec æ é¢ + 3-5 è¡æè¦
- Top 3 Open Questionsï¼å¦æï¼
ç»æè¯ï¼å¿ é¡»ï¼ï¼ âSpec å·²çæå¹¶ä¸æ¬¡æ§æäº¤ãReady to set up for implementation?â