بنقرة واحدة
documentation-templates
文件範本與結構指南。README、API 文件、程式碼註解與 AI 友善文件。
التثبيت باستخدام Codex أو Claude انسخ هذا Prompt والصقه في Codex أو Claude أو مساعد آخر ليراجع صفحة Skill ويثبّتها لك.
القائمة
文件範本與結構指南。README、API 文件、程式碼註解與 AI 友善文件。
التثبيت باستخدام Codex أو Claude انسخ هذا Prompt والصقه في Codex أو Claude أو مساعد آخر ليراجع صفحة Skill ويثبّتها لك.
استنادا إلى تصنيف SOC المهني
使用 Claude API / Anthropic SDK 建構、除錯和最佳化應用程式。使用此技能建構的應用程式應包含提示快取 (prompt caching)。也處理在 Claude 模型版本之間遷移現有 Claude API 程式碼(4.5 → 4.6,4.6 → 4.7,替換已退役模型)。觸發時機:程式碼匯入 anthropic/@anthropic-ai/sdk;使用者要求使用 Claude API、Anthropic SDKs 或 Managed Agents (/v1/agents, /v1/sessions, /v1/environments);使用者在檔案中新增/修改/調整 Claude 功能(快取、思考、壓縮、工具使用、批次、檔案、引用、記憶)或模型(Opus/Sonnet/Haiku);關於 Anthropic SDK 專案中提示快取/快取命中率的問題。不觸發:檔案匯入 `openai`/其他提供者 SDK,檔案名稱類似 `*-openai.py`/`*-generic.py`,與提供者無關的程式碼,一般程式設計/機器學習。
當編寫呼叫 Gemini API 的程式碼時請使用此技能,用於文字生成、多輪對話、多模態理解、影像生成、串流回應、背景研究任務、函式呼叫、結構化輸出,或從舊的 generateContent API 遷移。此技能涵蓋 Interactions API,這是在 Python 與 TypeScript 中使用 Gemini 模型與代理的建議方式。
Tailwind CSS v4 原則。CSS 優先配置、容器查詢、現代模式、設計 token 架構。
處理使用 Gemini Live API 的即時、雙向串流應用程式時使用此技能。涵蓋基於 WebSocket 的音訊/視訊/文字串流、語音活動偵測 (VAD)、原生音訊功能、函式呼叫、會話管理、用戶端身分驗證的臨時權杖,以及所有 Live API 設定選項。涵蓋的 SDK - google-genai (Python)、@google/genai (JavaScript/TypeScript)。
Python 開發原則與決策。框架選擇、非同步模式、型別提示、專案結構。教你思考而非複製。
自動代理選擇與智慧任務路由。分析使用者請求並自動選擇最佳專家代理,無需使用者明確提及。
| name | documentation-templates |
| description | 文件範本與結構指南。README、API 文件、程式碼註解與 AI 友善文件。 |
| allowed-tools | Read, Glob, Grep |
常見文件類型的範本與結構指南。
| 章節 | 用途 |
|---|---|
| 標題 + 一行描述 | 這是什麼? |
| 快速入門 | 5 分鐘內運行 |
| 功能 | 我能做什麼? |
| 設定 | 如何自訂 |
| API 參考 | 連結到詳細文件 |
| 貢獻 | 如何幫忙 |
| 授權 | 法律 |
# 專案名稱
簡短一行描述。
## 快速入門
[運行的最少步驟]
## 功能
- 功能 1
- 功能 2
## 設定
| 變數 | 描述 | 預設值 |
|------|------|--------|
| PORT | 伺服器埠口 | 3000 |
## 文件
- [API 參考](./docs/api.md)
- [架構](./docs/architecture.md)
## 授權
MIT
## GET /users/:id
透過 ID 取得使用者。
**參數:**
| 名稱 | 型別 | 必填 | 描述 |
|------|------|------|------|
| id | string | 是 | 使用者 ID |
**回應:**
- 200:使用者物件
- 404:找不到使用者
**範例:**
[請求和回應範例]
/**
* 函式功能的簡短描述。
*
* @param paramName - 參數描述
* @returns 回傳值描述
* @throws ErrorType - 此錯誤發生的時機
*
* @example
* const result = functionName(input);
*/
| ✅ 要註解 | ❌ 不要註解 |
|---|---|
| 為什麼(業務邏輯) | 什麼(顯而易見的) |
| 複雜演算法 | 每一行 |
| 非顯而易見的行為 | 自解釋的程式碼 |
| API 契約 | 實作細節 |
# 變更日誌
## [未發布]
### 新增
- 新功能
## [1.0.0] - 2025-01-01
### 新增
- 初始發布
### 變更
- 更新依賴
### 修復
- Bug 修復
# ADR-001:[標題]
## 狀態
已接受 / 已棄用 / 已取代
## 情境
為什麼我們要做這個決策?
## 決策
我們決定了什麼?
## 後果
權衡是什麼?
給 AI 爬蟲和代理:
# 專案名稱
> 一行目標。
## 核心檔案
- [src/index.ts]:主要入口
- [src/api/]:API 路由
- [docs/]:文件
## 關鍵概念
- 概念 1:簡短說明
- 概念 2:簡短說明
為 RAG 索引:
| 原則 | 原因 |
|---|---|
| 可掃描 | 標題、列表、表格 |
| 範例優先 | 展示,而不只是說明 |
| 漸進式細節 | 簡單 → 複雜 |
| 保持最新 | 過時 = 誤導 |
記住: 範本是起點。根據你的專案需求調整。