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".
仅公开文件列表。将技能安装到工作区后即可查看文件内容。
| 路径 | 大小 | 类型 |
|---|---|---|
| SKILL.md | 6.3 KB | text/markdown |
来源与署名
来源：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
将现有品牌语调指南应用于销售和营销内容，并说明所采用的品牌选择。