Documenting Contracts
riekelt/technical-writer/plugins/technical-writer/skills/documenting-contracts作者 riekelt85e53729dd95無授權條款28 個星標收錄於 2026年10月8日更新於 2026年10月8日儲存庫3 週前更新
Use when documenting an HTTP API, message payloads, queue contracts, DTOs, file formats, or webhooks - or when writing the api-reference of a legacy campaign, or when callers keep asking what a field means or which errors an endpoint returns. Encodes the four detail levels, the DTO-first catalog, wire types with source anchors, the generated-spec one-home rule, and omitted-versus-null semantics. Use whenever a machine interface needs documenting for its callers, even if nobody says "API docs".
- 85e53729dd95目前提交 85e5372發布於 2026年10月8日
來源與署名
來源：riekelt/technical-writer位於plugins/technical-writer/skills/documenting-contracts提交85e5372
授權條款： 無授權條款
內容歸原作者所有。SourceWeft 從公開儲存庫中收錄這些內容。
更多來自 riekelt/technical-writer 的技能
Writing Runbooks
riekelt
指導撰寫供人在時間壓力下執行的操作手冊、安裝、發佈、遷移與棄用流程文件。
Writing Postmortems
riekelt
指導撰寫不究責的事後檢討、事故報告與根因分析，包含以證據為基礎的時間軸與有歸屬的待辦事項。
Writing Issues
riekelt
指導撰寫追蹤系統中的議題，例如史詩、故事、任務、缺陷與調查，並提供可測試的驗收標準。
Writing Design Docs
riekelt
指導撰寫提案、RFC、設計文件、規格與遷移計畫，提供固定骨架與完整性檢查。
Writing Changelogs
riekelt
指導撰寫變更日誌條目、發行說明與交接摘要，規範條目結構與誠實性慣例。
Technical Writing
riekelt
用於撰寫、重整與修訂技術文件（如規格、設計文件、README）的內部風格與真實性規則。
更多Writing & Content技能
Doc Coauthoring
anthropics
引導使用者透過三階段工作流程協作撰寫文件、提案、技術規格與決策文件。
Writing Guidelines
vercel-labs
依據取得的寫作指南審查文件與文稿，並回報風格問題。
Job Post Builder
anthropics
依職缺需求產出招募文件包：職缺公告、面試指南與評分表，以及錄取通知書範本。
Write Spec
anthropics
把功能構想或問題陳述轉成結構化 PRD，包含目標、使用者故事、需求與指標。
Draft Content
anthropics
撰寫部落格文章、社群貼文、電子報、到達頁、新聞稿與案例研究等行銷內容。
Brand Voice Enforcement
anthropics
將現有品牌語調指南套用於銷售與行銷內容，並說明所採用的品牌選擇。