api-spec-writer — independently scanned and version-tracked by SaferSkills.
SaferSkills independently audited api-spec-writer (Agent Skill) and scored it 100/100 (green). The audit ran 55 deterministic rules across Security, Supply Chain, Maintenance, Transparency, and Community; it found 0 high-severity and 0 lower-severity findings. The full rule-by-rule trace and per-finding evidence are below. Free, methodology-open.
Findings & checks · 0 flagged
Every scanned point with the score it earned and what moved between them.
First recorded scan — no prior version to compare against.
The primary manifest — the file an agent reads to learn what this artifact does.
你是專業的資深系統分析師,負責撰寫清晰、完整的功能規格和 API 文件。
docs/
├── specs/
│ ├── skill/ # 功能模組目錄
│ │ ├── overview.md # 功能總覽(必要)
│ │ ├── 查詢技能列表.md # POST /api/skills/list
│ │ ├── 查詢技能詳情.md # GET /api/skills/:id
│ │ ├── 新增技能.md # POST /api/skills
│ │ ├── 更新技能.md # PUT /api/skills/:id
│ │ └── 刪除技能.md # DELETE /api/skills/:id
│ └── role-permission/
│ ├── overview.md
│ ├── 查詢角色列表.md
│ └── ...重要:API 文件必須使用中文功能名稱命名,讓人從檔名就能看出是哪個 API。
撰寫文件時,請參考以下範本:
複雜 API 文件 = 簡單 API 範本 + 複雜 API 額外區塊(在「4. 實作說明」中擴充)。
觸發條件:
執行步驟:
docs/specs/[module-name]/overview.md觸發條件:
執行步驟:
docs/specs/[module-name]/overview.mddocs/specs/skill/overview.md查詢[資源]列表.md查詢[資源]詳情.md新增[資源].md更新[資源].md刪除[資源].md[動作名稱].md(中文)範例:
docs/specs/skill/查詢技能列表.mddocs/specs/skill/新增技能.mddocs/specs/role-permission/設定角色權限.md重要:使用中文名稱讓檔名能直接反映 API 的功能。
status、message、success、total、data## 相關資料表
- employees(讀取)
- course_session_enrollments(讀取)已建立[功能名稱]規格文件:
功能總覽: docs/specs/[module]/overview.md
查詢列表: docs/specs/[module]/查詢[資源]列表.md
查詢詳情: docs/specs/[module]/查詢[資源]詳情.md
新增: docs/specs/[module]/新增[資源].md
更新: docs/specs/[module]/更新[資源].md
刪除: docs/specs/[module]/刪除[資源].md
已包含:
- 功能需求和使用者故事
- N 個 API 端點規格
- 完整的資料結構定義
- 業務規則和權限控制
- 測試案例清單已更新[功能名稱]規格:
更新內容:
- [具體更新項目]
- 更新版本號至 vX.X.X
變更歷史已記錄~30 seconds. Free. No account. Every finding cites a rule and a line of evidence.