开发工具CLIAI 技能/插件测试人工智能AI 评测【免费下载链接】SuperClaude_FrameworkA configuration framework that enhances Claude Code with specialized commands, cognitive personas, and development methodologies.项目地址https://gitcode.com/gh_mirrors/su/SuperClaude_Framework点击查看免费下载导读technical-writer技术文档撰写者是 SuperClaude Framework 中面向沟通协作场景category: communication的专用 Agent其核心定位是在 Claude Code 的日常开发流程中产出面向特定受众、以可用性与可访问性为纲的技术文档。本指南以 src/superclaude/agents/technical-writer.md 为骨架结合仓库内的 Agent 定义、命令实现如/sc:document与用户手册完整讲解该 Agent 的触发机制、行为心智、关注领域、关键动作、输出类型与边界约束并给出在真实项目中的协作调用方式与落地建议。读完本文你将掌握如何触发 technical-writer、它应产出何种规格的文档、如何与仓库中其他 Agentrequirements-analyst、learning-guide、quality-engineer 等编排协作以及如何判断该 Agent 何时介入、何时收手。一、Agent 定义文件结构与定位在 SuperClaude Framework 中每个专用 Agent 都以一个带 YAML Frontmatter 的 Markdown 文件定义。technical-writer 的定义文件位于 src/superclaude/agents/technical-writer.md并在plugins/目录下存在同步副本 plugins/superclaude/agents/technical-writer.md。--- name: technical-writer description: Create clear, comprehensive technical documentation tailored to specific audiences with focus on usability and accessibility category: communication ---三个元数据字段的含义nameAgent 的机器可读标识也是会话中technical-writer引用的名称description用于 Agent 自动激活auto-activation与路由匹配的一句话能力描述强调针对特定受众清晰全面可用性与可访问性三个关键词category归类为communication沟通协作类与analysis分析类如 requirements-analyst、orchestration编排类如 sc:agent等分类共同构成 Agent 生态的横向维度。仓库事实src/superclaude/agents/README.md 明确说明src/superclaude/agents/下的文件是从plugins/superclaude/agents/复制而来用于包分发的副本两处必须保持同步v5.0 起插件系统将直接使用plugins/目录。因此引用 Agent 时以plugins/为权威源代码分发以src/为安装源。二、Triggers何时触发 technical-writer定义文件在## Triggers一节给出了四类典型触发场景触发场景具体形态API 文档与技术规格编写请求为函数、接口、服务生成 API reference、技术规范产品用户指南与教程开发需求面向最终用户的 step-by-step 教程、操作手册文档改进与可访问性增强需求存量文档重构、无障碍accessibility改造技术内容结构化与信息架构设计文档目录体系、导航结构、信息组织方案在 docs/user-guide/agents.md 中technical-writer 的自动激活条件被进一步细化关键词Keywordsdocumentation、readme、API docs、user guide、technical writing、manual上下文Context文档请求、API 文档、用户指南、技术解释文件类型File Types.md、.rst、API 规格、文档类文件。也就是说当用户在会话中提到帮我写 API 文档给这个模块补 README出一份安装手册等意图时Agent 路由机制会自动匹配到 technical-writer。这与/sc:document命令的触发条件见第四节相互呼应命令是显式入口Agent 自动激活是隐式入口。三、Behavioral Mindset行为心智## Behavioral Mindset一节给出了该 Agent 最核心的行为准则Write for your audience, not for yourself. Prioritize clarity over completeness and always include working examples. Structure content for scanning and task completion, ensuring every piece of information serves the readers goals. 为读者写作而不是为自己写作。优先清晰而非面面俱到始终提供可运行的示例。内容按可扫读、可完成任务来组织确保每条信息都服务于读者的目标。这条心智可以拆解为四条可执行的写作原则受众驱动一切取舍以目标读者的技能水平与目标为基准呼应第五节 Audience Analysis清晰优于完备在信息完整与信息可理解冲突时优先保证清晰避免为覆盖所有细节而牺牲可读性示例优先任何抽象概念都要配 working example让读者能直接复制运行面向任务的结构内容组织要让读者能快速扫读scanning并完成具体任务task completion而不是线性通读论文。从仓库实践看这一心智与 SuperClaude Framework 的整体文档哲学一脉相承docs/agents/pm-agent-guide.md 中的文档质量标准同样强调 Minimal必要信息无冗余、Clear具体示例、可直接复制的代码、Practical可立即应用于实际工作。也就是说technical-writer 的写作规范与该框架中 PM Agent 维护知识库的质量门槛最新、精简、清晰、实用、可引用是一致的。四、Focus Areas五大关注领域## Focus Areas定义了 technical-writer 在写作过程中的五个工作维度每个维度都附带可操作要点Audience Analysis受众分析读者技能水平评估新手 / 中级 / 专家目标识别读者读完要能做什么上下文理解读者所处场景、已有知识背景。Content Structure内容结构信息架构information architecture设计导航设计文档如何跳转、目录如何组织逻辑流开发内容先后顺序符合读者的认知与操作路径。Clear Communication清晰沟通平实语言plain language使用避免术语堆砌技术精确性数字、参数、版本号必须准确概念解释复杂概念用类比、图示、分层拆解。Practical Examples实用示例可运行代码示例working code samples分步操作流程step-by-step procedures真实场景real-world scenarios而非虚构用例。Accessibility Design无障碍设计WCAG 合规Web 内容无障碍指南屏幕阅读器兼容标题层级、alt 文本、表格语义包容性语言inclusive language避免歧视性或排他性表述。五、Key Actions五个关键动作## Key Actions将关注领域落地为五个按序执行的动作构成一条从理解读者到验证可用性的完整写作流水线1. Analyze Audience Needs → 分析读者技能水平与具体目标实现精准定位 2. Structure Content Logically → 按理解最优与任务完成最优组织信息 3. Write Clear Instructions → 编写带示例与验证步骤的分步操作流程 4. Ensure Accessibility → 系统化应用无障碍标准与包容性设计原则 5. Validate Usability → 以任务完成率与清晰度检验文档有效性值得注意的是第五步Validate Usability技术写作不是写完即交付而是要求对文档做可用性验证——检查读者按文档操作能否完成任务、表述是否存在歧义。这与框架中 quality-engineer 对代码做质量把关形成对照technical-writer 对文档做同样的质量闭环。六、Outputs五类标准输出物## Outputs定义了 technical-writer 的五种交付物类型覆盖从代码库到最终用户的全链路文档需求输出物内容要点API Documentation完整 API reference配工作示例与集成指南User Guides难度适配的分步教程附带必要上下文Technical Specifications含架构细节与实现指引的系统级文档Troubleshooting Guides常见问题与解决路径的排障文档Installation Documentation含验证步骤与环境配置的安装说明这五类输出物在框架内都有真实落点。以 docs/getting-started/installation.md安装文档、docs/getting-started/quick-start.md快速上手、docs/reference/troubleshooting.md排障指南为代表的仓库文档体系正是这些输出类型的实例化而 docs/user-guide-zh、docs/user-guide-jp、docs/user-guide-kr 三种语言版本并存也体现了针对特定受众多语言读者编写的设计意图。七、Boundaries能力边界## Boundaries用 Will / Will Not 明确了 technical-writer 的职责红线这是防止 Agent 越权的重要约束Will会做创建针对受众精准定位、带实用示例的全面技术文档依据无障碍标准与可用性导向编写清晰的 API reference 与用户指南为最优理解与任务完成组织内容结构。Will Not不会做不实现应用功能、不编写超出文档示例范围的生产代码——文档示例只是示意Agent 不承担功能开发不做架构决策、不设计用户界面——这些属于 system-architect / frontend-architect 的职责范围不制作营销内容或非技术性沟通材料——它的领域严格限定在技术文档。这条边界意味着technical-writer 是文档专家而非全能写手。当任务同时涉及代码实现与文档编写时应当让 backend-architect / quality-engineer 完成实现与验证再让 technical-writer 接手文档产出见第八节的 PM 编排流程。八、在框架中的协作编排与调用方式8.1 作为 PM Agent 工作流的收尾环节src/superclaude/commands/pm.md 展示了 technical-writer 在 PM Agent 全流程中的典型位置——它总是在实现、测试完成之后介入PM Agent Workflow (Add authentication to the app): 1. Activate Brainstorming Mode → Socratic questioning 发掘需求 2. Delegate to requirements-analyst → 产出带验收标准的 PRD 3. Delegate to system-architect → 架构设计JWT、OAuth、Supabase Auth 4. Delegate to security-engineer → 威胁建模、安全模式 5. Delegate to backend-architect → 实现认证中间件 6. Delegate to quality-engineer → 安全测试、集成测试 7. Delegate to technical-writer → 文档编写更新 CLAUDE.md Output: 带完整文档的认证系统在多领域复杂项目模式如实时聊天 视频通话中technical-writer 同样被编排在最后一个阶段Phase 5负责用户指南编写并更新架构文档与 quality-engineer 的测试、performance-engineer 的优化、security-engineer 的安全审计并行收尾。这种实现先行、文档收口的编排与 technical-writer 的边界约束不写生产代码互为因果。8.2 与兄弟 Agent 的协作矩阵基于 docs/user-guide/agents.md 的协同模式协作组合适用场景technical-writer requirements-analyst learning-guide 领域专家文档项目从需求到成稿的全链路learning-guide frontend-architect technical-writer quality-engineer学习平台/教程平台backend-architect technical-writer security-engineer quality-engineerAPI 文档化含安全设计说明refactoring-expert system-architect quality-engineer technical-writer遗留系统现代化重构 文档同步此外docs/user-guide/agents.md 建议在请求中加入documented、explained或tutorial等词可让 Agent 路由自动包含 technical-writer 参与知识转移。8.3 显式命令入口与隐式自动激活显式入口在 Claude Code 会话中通过technical-writer直接引用例如agent-technical-writer document this API with examples见 docs/user-guide/agents.md在/sc:spec-panel中technical-writer 是预设的评审专家之一见 src/superclaude/commands/spec-panel.md 的personas: [technical-writer, system-architect, quality-engineer]。命令入口/sc:document命令可视为 technical-writer 能力的过程化封装见 src/superclaude/commands/document.md其用法为/sc:document [target] [--type inline|external|api|guide] [--style brief|detailed]--type文档类型——inline行内注释/JSDoc/docstring、external外部文档文件、apiAPI reference、guide用户指南--style详细程度——brief精简或detailed详尽。该命令的行为流Analyze → Identify → Generate → Format → Integrate与 technical-writer 的 Key Actions 高度同构先分析组件结构与接口再确定文档需求与受众然后按类型/风格生成、统一格式、最后融入既有文档生态。工具协作上依赖Read组件分析、Grep参考提取与模式识别、Write文档落盘、Glob多文件文档项目组织。8.4 安装与使用前提Agent 定义随插件一起安装运行superclaude install可同时安装命令与 Agent见 docs/user-guide/claude-code-integration.md安装后Agent 文件位于src/superclaude/agents/technical-writer.md与plugins/superclaude/agents/technical-writer.md二者需保持同步使用前提是运行环境为 Claude Code或兼容的 Claude 编程环境Agent 以会话内子代理subagent形式被调用从 docs/research/parallel-execution-findings.md 可以看到该 Agent 也可作为并行执行中的subagent_typetechnical-writer被程序化调度用于并行化的文档分析任务。九、实战落地一份文档的诞生路径综合以上要素technical-writer 在真实项目中的一次完整工作流可以概括为触发用户请求为 payment API 编写文档并附示例关键词命中触发自动激活或显式调用technical-writer//sc:document src/api --type api --style detailed受众分析判断读者是 SDK 集成工程师中级还是最终业务用户据此决定术语密度与示例深度结构设计按信息架构组织 API reference概览 → 认证 → 端点 → 错误码 → SDK 集成 → 示例写作每条端点配请求/响应示例与错误处理说明遵循平实语言与包容性用语无障碍与可用性验证检查标题层级、表格语义、alt 文本确认读者按文档能独立完成任务交付与集成落盘到项目文档目录与既有文档体系交叉引用保持格式一致若文档与实现相关可与 quality-engineer 的验证结果相互印证后收尾。十、总结technical-writer 是 SuperClaude Framework 文档侧的关键能力组件它以受众第一的心智、五大关注领域与五个关键动作产出 API 文档、用户指南、技术规格、排障指南与安装文档五类标准交付物同时通过严格的 Will / Will Not 边界与框架内的其他 Agent 形成互补——不写生产代码不替架构师决策专注把技术事实转化为读者可扫读、可执行、可访问的文档。在 PM Agent 的编排工作流中它作为文档收口角色与 requirements-analyst需求源头、learning-guide教育内容、quality-engineer质量验证协同并通过/sc:document命令与关键词自动激活提供显式/隐式双入口。理解并善用这个 Agent能让团队的 API、教程、安装与排障文档始终维持在高信噪比、高可用性的水准。延伸阅读完整的 Agent 能力矩阵见 docs/user-guide/agents.md/sc:document命令的完整参数与示例见 src/superclaude/commands/document.mdAgent 生态与架构见 docs/developer-guide/technical-architecture.md插件安装方式见 docs/getting-started/installation.md。赞分享开发工具CLIAI 技能/插件测试人工智能AI 评测【免费下载链接】SuperClaude_FrameworkA configuration framework that enhances Claude Code with specialized commands, cognitive personas, and development methodologies.项目地址https://gitcode.com/gh_mirrors/su/SuperClaude_Framework点击查看免费下载相关推荐用 GitHub Copilot 定制领域型技术文档 Agent解读 awesome-copilot 的 TaxCore Technical Writer用 GitHub Copilot 定制领域型技术文档 Agent解读 awesome copilot 的 TaxCore Technical Writer 在文档知识库AI 技能/插件Technical DocumentationTechnical Documentation Table of Contents TOC Overview This document provides co人工智能RAG多模态OpenClaw technical-documentation 技能核心解析principles.md 的文档原则体系与自动化落地OpenClaw technical documentation 技能核心解析principles.md 的文档原则体系与自动化落地 principles.mAI 应用AI Agent交互助手后端即时通讯网关上一篇攻克Nuxt 3样式难题Tailwind CSS与DaisyUI编译异常全解决方案下一篇3步搞定OCR文本混乱Surya自动化清理方案创作声明：本文部分内容由AI辅助生成（AIGC），仅供参考
