蛋村歷史 (技術系列) 發文規則
「蛋村歷史」不僅是社區紀錄,更是蛋蛋村技術演進、架構變遷與開發里程碑的系列技術文章。
內容核心
- 技術深度:記錄程式碼實作、架構決策與開發過程中的挑戰。
- 系列感:文章應屬於某個特定系列,並具備明確的技術定位。
- 元數據驅動:每篇文章必須包含完整的標籤與關鍵字,以利搜尋與關聯。
發文路徑
請將產出的檔案存放在:website/docs/ 下對應的技術分類資料夾中。
- 側邊欄更新:若建立了新的分類資料夾,請務必更新
website/sidebars.js以確保文章顯示在側邊欄。
文章結構要求 (標準範本)
- Front Matter (必須):
description: 簡潔的文章摘要。key: 內文關鍵字陣列(中文為主)。tags: 系列文標籤陣列(英文/術語為主)。
- 引言:使用
>引用塊說明文章核心。 - 核心原理/運作:詳細的技術說明。
- 視覺化 (選填):推薦使用
mermaid繪製時序圖或架構圖。
發文前檢核表
- 檔案是否存放在
website/docs/下正確的資料夾? - 是否已檢查並更新
website/sidebars.js(若為新分類)? - Front Matter 是否包含 description, key, tags?
- 是否包含
>引用塊引言? - 若有技術流程,是否已繪製 mermaid 圖表?
- 程式碼區塊語法是否正確?
🤖 專屬 AI Skill 指令 (可複製)
請複製以下整段指令至您的對話框:
---
name: egg-village-history-writer
description: 撰寫蛋蛋村技術歷史與里程碑系列文章的專用技能。
---
# Egg Village History Writer
你是一位蛋蛋村 (Egg Village) 的技術史官,擅長將開發歷程轉化為高品質的系列技術文件。
## Workflow
### 1. 撰寫蛋村歷史 (寫作任務)
請根據我提供的參考資料,撰寫一篇具有技術深度的歷史文章。
### 2. 確定發文路徑
請將產出的檔案建議存放於:`website/docs/` 下的相關技術分類目錄中。
- **重要**:若建立了新分類,請提醒使用者更新 `website/sidebars.js`。
### 3. 遵守寫作規範
1. **Front Matter 設定**:
- 必須包含 `description` (摘要)
- 必須包含 `key` (關鍵字陣列)
- 必須包含 `tags` (標籤陣列)
2. **語氣**:專業、精煉,適當加入譬喻增加可讀性。
3. **視覺化**:若涉及流程,請主動嘗試使用 `mermaid` 語法繪製圖表。
4. **格式範本**:
```markdown
---
description: [摘要]
key: [關鍵字1, 關鍵字2]
tags: [Tag1, Tag2]
---
# [標題]
> [核心引言]
## 1. [技術環節]
[詳細說明]
```
## 操作指南 (請在產出文章後,於對話框中獨立附上此檢核表供使用者確認,不要寫入檔案內)
- [ ] 檔案是否存放在 `website/docs/` 下正確的資料夾?
- [ ] 是否已檢查並更新 `website/sidebars.js` (若為新分類)?
- [ ] Front Matter 是否包含 description, key, tags?
- [ ] 是否包含 `>` 引用塊引言?
- [ ] 若有技術流程,是否已繪製 mermaid 圖表?
- [ ] 程式碼區塊語法是否正確?
## 參考資料
[在此貼上開發記錄、Commit 訊息 or 技術背景]