PRD Generator - 产åéæ±ææ¡£çæåš
æ¬æèœåž®å©å¿«éçæäžäžçº§äº§åéæ±ææ¡£ïŒPRDïŒïŒéçš UML çšäŸé©±å𿹿³è®ºïŒèŸåºç»æå®æŽãå¯çŽæ¥çšäºå¢éåäœçææ¡£ã
è§Šåæ¡ä»¶
åœçšæ·æå°ä»¥äžåºæ¯æ¶äœ¿ç𿬿èœïŒ
- å PRDãå产åéæ±ææ¡£
- å产åè§æ Œè¯Žæä¹Š
- 产å讟计ã产åè§å
- æ°åèœéæ±åæ
- çšäŸåæãçšäŸå»ºæš¡
- çæéæ±ææ¡£
å·¥äœæµçš
- éæ±æ¶éïŒäžçšæ·ç¡®è®€äº§åèæ¯ãæ žå¿åèœãç®æ çšæ·
- çšäŸå»ºæš¡ïŒè¯å«åäžè
â æ¢³ççšäŸ â 建ç«å
³ç³»ïŒInclude/ExtendïŒ
- è§æ ŒçŒåïŒææš¡æ¿çŒåæ¯äžªçšäŸç诊ç»è§æ ŒïŒå眮/å眮æ¡ä»¶ãäºä»¶æµãå€éæµïŒ
- 亀äºè®Ÿè®¡ïŒç»å¶æµçšåŸãæ¶åºåŸãç¶ææº
- UI è§èïŒå®ä¹åžå±ãç»ä»¶ãè²åœ©ãåäœ
- éåèœéæ±ïŒæç¡®æ§èœãå®å
šãå
Œå®¹æ§èŠæ±
- ææ¡£æŽåïŒçæå®æŽ PRD ææ¡£
ææ¡£ç»æ
çæç PRD å
å«ä»¥äžç« èïŒ
1. äº§åæŠè¿°
âââ 产åèæ¯
âââ 产åç®æ
âââ ç³»ç»èåŽïŒå«ç»ä»¶å®ä¹è¡šïŒ
2. UMLçšäŸæš¡å
âââ ç³»ç»çšäŸåŸïŒASCII åŸåœ¢ïŒ
âââ åäžè
å®ä¹
âââ çšäŸå衚ïŒçŒå·-åç§°-åäžè
ïŒ
âââ çšäŸå
³ç³»åŸ
3. 诊ç»çšäŸè§æ Œè¯Žæ
âââ æ¯äžªçšäŸå
å«ïŒ
âââ åºæ¬ä¿¡æ¯ïŒçŒå·/åç§°/åäžè
/äŒå
级ïŒ
âââ å眮/å眮æ¡ä»¶
âââ åºæ¬äºä»¶æµ
âââ å€éäºä»¶æµ
âââ äžå¡è§å
âââ æ°æ®è¯Žæè¡šïŒå段å®ä¹ïŒ
âââ æ¥å£è¯Žæ
4. 诊ç»äº€äºè®Ÿè®¡
âââ 页颿Žäœäº€äºæµçš
âââ åæµçšåŸïŒåŠæä»¶äžäŒ ïŒ
âââ ç¶ææºåŸ
âââ æ¶åºåŸïŒæ°æ®æµèœ¬ïŒ
âââ 远é®/å€èœ®å¯¹è¯æµçš
5. UI讟计è§è
âââ 页颿Žäœåžå±ïŒASCII 线æ¡åŸïŒ
âââ æ žå¿ç»ä»¶è®Ÿè®¡ïŒASCII 瀺æïŒ
âââ è²åœ©è§èïŒè²æ¿+è²åŒïŒ
âââ åäœè§èïŒåå·å±çº§ïŒ
âââ éŽè·è§èïŒåºç¡åäœïŒ
âââ ç»ä»¶ç¶æè§è
6. éåèœéæ±
âââ æ§èœéæ±
âââ å
Œå®¹æ§éæ±
âââ å®å
šéæ±
âââ å¯é æ§éæ±
7. éåœ
âââ æ¯è¯è¡š
âââ åèèµæ
æ žå¿æš¡æ¿
çšäŸè§æ Œæš¡æ¿
### UC-XX [çšäŸåç§°]
| é¡¹ç® | å
容 |
|------|------|
| **çšäŸçŒå·** | UC-XX |
| **çšäŸåç§°** | [çšäŸåç§°] |
| **åäžè
** | [åäžè
å衚] |
| **å眮æ¡ä»¶** | [å眮æ¡ä»¶æè¿°] |
| **å眮æ¡ä»¶** | [å眮æ¡ä»¶æè¿°] |
| **åºæ¬äºä»¶æµ** | 1. [æ¥éª€1]<br>2. [æ¥éª€2]<br>3. [æ¥éª€3] |
| **å€éäºä»¶æµ** | 1a. [åŒåžž1]ïŒç³»ç»[å€çæ¹åŒ]<br>2a. [åŒåžž2]ïŒç³»ç»[å€çæ¹åŒ] |
| **äžå¡è§å** | 1. [è§å1]<br>2. [è§å2] |
#### æ°æ®è¯Žæè¡š
**[衚å]ïŒtable_nameïŒ**
| åæ®µå | åæ®µäžæå | æ°æ®ç±»å | ååŒèåŽ | æ¯åŠå¿
å¡« | 倿³šè¯Žæ |
|--------|------------|----------|----------|----------|----------|
| field_name | åæ®µäžæå | VARCHAR(100) | ä»»æå笊䞲 | æ¯/åŠ | åæ®µè¯Žæ |
| **äŒå
级** | [é«/äž/äœ] |
|------------|----|
æ¶åºåŸæš¡æ¿
âââââââââââââââââââââââââââââââââââââââââââââââââââââââââââââââââââ
â [æ é¢] â
âââââââââââââââââââââââââââââââââââââââââââââââââââââââââââââââââââ
åäžè
A åäžè
B åäžè
C
â â â
â 1. [æäœæè¿°] â â
â âââââââââââââââââââââââ⺠â
â â 2. [å€çæäœ] â
â â âââââââââââ⺠â
â â â
â 3. [è¿åç»æ] â â
â ââââââââââââââââââââââââ â
â â â
æ°æ®åå
žæš¡æ¿
**åæ®µç±»åæäžŸ**ïŒ
- STRING/VARCHAR: å笊䞲类å
- INT/BIGINT: æŽæ°ç±»å
- DECIMAL: å°æ°ç±»å
- BOOLEAN: åžå°ç±»å
- DATETIME: æ¥ææ¶éŽç±»å
- JSON: JSON 对象/æ°ç»
- UUID: å¯äžæ è¯ç¬Š
**ç¶æåæ®µæäžŸ**ïŒ
- PENDING: åŸ
å€ç
- PROCESSING: å€çäž
- COMPLETED: 已宿
- ERROR/FAILED: é误/倱莥
- ACTIVE: 掻è·
- INACTIVE: æªæ¿æŽ»
åžžçšæåŸç±»åïŒæ°æ®åæç±»äº§åïŒ
| æåŸç±»å | 诎æ | å
³èåŸè¡š |
|---|
| BAR | æ±ç¶åŸæåŸ | æ±ç¶åŸ |
| LINE | æçº¿åŸæåŸ | æçº¿åŸ |
| PIE | é¥ŒåŸæåŸ | é¥ŒåŸ |
| SCATTER | æ£ç¹åŸæåŸ | æ£ç¹åŸ |
| TABLE | è¡šæ Œå±ç€ºæåŸ | æ°æ®è¡šæ Œ |
| FILTER | æ°æ®çéæåŸ | ç鿡件 |
| AGREGATE | èåæ¥è¯¢æåŸ | ç»è®¡ç»æ |
| CONDITION | æ¡ä»¶å€ææåŸ | å€æç»æ |
èŸåºæ ŒåŒ
çæç PRD ææ¡£åºïŒ
- äœ¿çš Markdown æ ŒåŒ
- å
å«å®æŽç ASCII åŸåœ¢ïŒçšäŸåŸãæµçšåŸãæ¶åºåŸïŒ
- æ°æ®å段䜿çšè¡šæ Œæž
æ°å±ç€º
- 代ç åäœ¿çš ``` æ è®°
- ææ¡£å€Žéšå
å«çæ¬ãæ¥æãç¶æä¿¡æ¯
瀺äŸèŸåº
è¯Šè§ references/examples.md