custom-plugin-technical-writer
一个专为技术文档工程师设计的Claude Code插件,提供API文档、用户指南和代码示例生成技能。
安装使用
复制下面这段提示词发给你的 AI(Claude / Cursor / TRAE / Codex / WorkBuddy 等),它会自动帮你完成安装:
帮我安装这个 AI Skill:custom-plugin-technical-writer。 它的用途是:一个专为技术文档工程师设计的Claude Code插件,提供API文档、用户指南和代码示例生成技能。 完整的 Skill 内容见:https://321skill.com/skills/custom-plugin-technical-writer/raw/index.md 请读取该页面内容,如果是 SKILL.md 格式直接安装,如果是 README 提炼核心 prompt 后安装。
提示词包含完整的 Skill 内容链接,AI 读取后即可完成安装。你也可以 查看完整内容 确认无误。
使用示例
'请使用api-docs技能,为这个用户登录的RESTful API端点生成OpenAPI格式的文档描述。',它会根据你提供的接口信息,生成包含路径、参数、请求/响应示例等完整要素的API文档草稿。或者
对AI说:'用guides技能为这个数据导出功能写一个分步操作教程。',它会生成一个包含前置条件、操作步骤和结果验证的清晰指南。
介绍
Technical Writer Assistant 是一个专为技术文档创作设计的Claude Code插件,旨在解决开发者和文档工程师在撰写高质量技术文档时面临的效率和质量问题。它通过集成的AI智能体,能够快速生成结构清晰、内容准确的技术文档,覆盖从API接口说明到用户操作指南的全流程。
该插件提供三种核心技能:api-docs用于生成符合OpenAPI/Swagger规范的API文档;guides用于创建详细的用户指南和教程;examples用于产出附带注释的代码示例。用户可以通过简单的命令调用或技能组合,快速完成各类技术文档的起草和润色工作。
它特别适合需要频繁产出技术文档的开发者、文档工程师以及技术团队负责人。无论是为内部项目编写说明,还是为对外产品制作用户手册,都能显著提升文档产出的速度与专业性。
建议用户在使用前明确文档的目标读者和用途,以便选择最合适的技能组合。对于复杂的项目,可以先使用api-docs生成框架,再结合guides和examples填充细节,最后进行人工校对和风格统一。
核心特点
与通用写作助手不同,它深度集成了技术文档的特定格式和规范(如OpenAPI/Swagger),并能生成附带上下文的代码示例。其技能设计直接针对技术文档工程师的工作流,而非泛泛的文本创作。
注意事项
不适合创作创意性、营销类或高度依赖领域专有知识的非技术性文档。
常见问题
这个插件能帮我写哪些类型的技术文档?
主要擅长API文档、用户指南/教程、带注释的代码示例三类技术文档。
需要我提供什么信息才能生成文档?
通常需要提供代码、接口定义、项目背景或简要的产品功能描述作为输入。
给 AI 助手的安装指引
如果你的 AI 编程助手(Claude Code、Cursor、TRAE 等)能看到这个页面,把下面这段发给它即可自动完成安装:
请访问 https://321skill.com/skills/custom-plugin-technical-writer/raw/index.md 读取 custom-plugin-technical-writer 的原始 Skill 定义(Markdown 格式),按其中说明在我的环境里完成安装和配置。
AI 可直接读取的原始 Markdown 地址:/skills/custom-plugin-technical-writer/raw/index.md(查看排版版本)