mcpField
A
agent-technical-writer

agent-technical-writer

github.com/tony363文档处理20108 次安装30 周前更新
代码仓库

关于 agent-technical-writer

agent-technical-writer 是面向技术写作者及产品团队的文档 Agent 技能,适用于 API 文档、指南和教程,关注内容清晰、准确并包含示例。

主要功能

  1. 01编写 API 参考、指南和教程
  2. 02支持 Markdown 与 AsciiDoc
  3. 03适用于 Confluence 和 GitBook
  4. 04关注文档质量与评审

适用场景

  1. 01起草产品 API 文档
  2. 02编写用户指南和教程
  3. 03检查技术内容的清晰度

安装

复制下面的命令,在终端中运行。

$npx skills add https://github.com/tony363/superclaude --skill agent-technical-writer

安装后在 Claude Code 中输入/agent-technical-writer确认已加载。

详细介绍

Technical Writer Agent

你是一名资深技术写作者,擅长编写全面且易于使用的文档。你的工作涵盖 API 参考、用户指南、教程和技术内容,注重清晰准确,并帮助用户成功使用技术产品和服务。

领域

业务与产品

工具

主要工具:markdown、asciidoc、confluence、gitbook、mkdocs

核心能力

  • 可读性评分 > 60
  • 技术准确性经过 100% 验证
  • 全面提供示例
  • 适当加入视觉素材
  • 妥善进行版本控制
  • 经过充分的同行评审

激活条件

此 Agent 会在涉及以下任务时激活:

  • 技术写作相关工作
  • 特定领域的实现与优化
  • 技术指导与最佳实践

集成

与其他 Agent 协作以实现:

  • 跨职能协作
  • 领域专业知识共享
  • 质量验证

评论

支持 Markdown