Reference Docs
API与符号文档编写模式库
安装使用
复制下面这段提示词发给你的 AI（Claude / Cursor / TRAE / Codex / WorkBuddy 等），它会自动帮你完成安装：
帮我安装这个 AI Skill：Reference Docs。 它的用途是：API与符号文档编写模式库 完整的 Skill 内容见：https://321skill.com/skills/reference-docs/raw/index.md 请读取该页面内容，如果是 SKILL.md 格式直接安装，如果是 README 提炼核心 prompt 后安装。
提示词包含完整的 Skill 内容链接，AI 读取后即可完成安装。你也可以 查看完整内容 确认无误。
使用示例
'请使用Reference Docs模式为我生成一个Python函数calculate_discount的API文档，包含参数说明和返回值示例。' 它会输出标准化的文档模板，包括函数签名、参数列表、类型提示、返回值描述和异常说明，你只需填充具体业务逻辑即可。
介绍
在日常开发中，编写高质量的API文档、参数表格和技术规范往往耗时且容易遗漏细节。Reference Docs 提供了一套经过验证的文档编写模式，涵盖函数签名、参数说明、返回值、异常处理等常见场景的标准化写法，帮助开发者快速生成结构清晰、风格统一的参考文档。
使用方式极为简单：在编写文档时，直接引用该仓库中的模式模板，根据实际API调整参数名称和描述即可。支持多种编程语言和框架的符号文档格式，可配合注释生成工具（如JSDoc、Sphinx等）使用，大幅提升文档产出效率。
适合所有需要编写API参考文档的开发者，尤其是后端开发、全栈开发、文档工程师以及开源项目维护者。对于团队协作项目，统一文档风格能显著降低沟通成本，让新成员更快理解接口规范。
建议在项目初期即引入该技能，与代码仓库同步维护。注意模式模板提供了骨架，具体描述仍需根据业务逻辑填充，不可完全照搬。对于非标准或自定义的复杂接口，可能需要适当调整模式结构。
核心特点
与通用的文档生成工具不同，Reference Docs 专注提供可复用的文档编写模式而非自动生成，更强调人类可读性和团队一致性，特别适合需要人工审核和补充细节的API文档场景。
注意事项
不适合自动生成文档、或需要完全无人工干预的场景，也不支持非结构化或极简风格的文档需求。
常见问题
这个技能支持哪些编程语言？
支持主流语言如JavaScript、Python、Java、C++等，模式模板语言无关，可根据需要调整。
可以直接用它生成JSDoc注释吗？
可以，模式模板与JSDoc格式兼容，直接套用后填充具体内容即可。
给 AI 助手的安装指引
如果你的 AI 编程助手（Claude Code、Cursor、TRAE 等）能看到这个页面，把下面这段发给它即可自动完成安装：
请访问 https://321skill.com/skills/reference-docs/raw/index.md 读取 Reference Docs 的原始 Skill 定义（Markdown 格式），按其中说明在我的环境里完成安装和配置。
AI 可直接读取的原始 Markdown 地址：/skills/reference-docs/raw/index.md（查看排版版本）