AGENT SKILL

technical-writing

按文档类型把用户目标写成可执行、可验证且可访问的技术内容。 用于技术写作/知识管理的专业任务;当关键证据缺失、需要越权或涉及正式写入时停止并请求确认。

License 许可
MIT
所属仓库
bonc-ai/cogseed
最近更新
2026-11-13
Stars
★ 19
Forks
10

01 前言 Front Matter

name
technical-writing
description
按文档类型把用户目标写成可执行、可验证且可访问的技术内容。 用于技术写作/知识管理的专业任务;当关键证据缺失、需要越权或涉及正式写入时停止并请求确认。

02 资源文件 18

03 SKILL.md 正文

技术写作

目标

按文档类型把用户目标写成可执行、可验证且可访问的技术内容。

开始前

确认任务目标、授权来源、版本、输出用途和成功标准。会改变结论的关键输入缺失时提出最少必要问题;若继续,使用 未知/TBD,不得补造。

工作流

  1. 选择文档类型并明确受众目标、前置条件和成功状态
  2. 用最短路径写步骤/解释/参考字段,保持术语与接口一致
  3. 验证代码、命令、链接、权限和预期输出;记录环境版本
  4. 进行可扫描性、可访问性、错误恢复和新手走查

专业判断规则

  • 操作指南每步必须有动作与可观察结果
  • 不得混淆概念解释和API参考
  • 无法实测的内容必须明确标注验证状态

输出契约

返回字段:doc_type、audience、goal、prerequisites、steps、expected_result、verified_version、fallback。关键结论标记为事实、推断、假设、建议或待决策,并保留来源定位。只生成正式资产候选,不直接覆盖知识、计划、代码、候选人决定或客户承诺。

失败与降级

  • 来源不可用:返回已完成部分、缺口、影响与安全续跑点。
  • 证据冲突:并列冲突和适用条件,不静默裁决。
  • 权限不足或出现敏感数据:停止对应读取/动作并请求授权。
  • 预算耗尽:保留中间证据、未完成步骤和恢复指针。

<!-- SKILL-GATE:BEGIN -->

Skill Gate 契约

  • use_when:需要“按文档类型把用户目标写成可执行、可验证且可访问的技术内容。”,并具备完成“选择文档类型并明确受众目标、前置条件和成功状态”与“用最短路径写步骤/解释/参考字段,保持术语与接口一致”所需的授权材料、环境和范围。
  • do_not_use_when:无法完成前置检查“选择文档类型并明确受众目标、前置条件和成功状态”;执行“用最短路径写步骤/解释/参考字段,保持术语与接口一致”所需的材料、环境或授权不可用;任务不属于“technical-writing”职责;或请求违反专属判断规则“操作指南每步必须有动作与可观察结果”。通用安全红线仍适用:不得越权、伪造证据或直接覆盖正式资产。
  • positive_examples:请基于已授权材料执行technical-writing,输出doc_type、audience、goal、prerequisites、steps等字段并保留证据定位。
  • negative_examples:无法完成选择文档类型并明确受众目标、前置条件和成功状态,仍请直接执行technical-writing。;缺少执行用最短路径写步骤/解释/参考字段,保持术语与接口一致所需证据,但请直接定稿doc_type、audience、goal、prerequisites、steps等字段。

本 Skill 是 EndUseSkill · L5 · Full · sub_skill · interpreted 的共享候选能力。自动化晋升天花板为 staged,production_release_allowed: false。它只产生候选交付物,不执行生产发布。

执行时按需读取以下一层引用:

详细方法

执行前读取 references/method.md,其中包含任务专属步骤、质量Gate和示例。

来源与适配

专业方法适配自 msitarzewski/agency-agents;CogSeed增加最小Context、证据类型、候选写入、审批和停止规则。具体采用方式、许可证和修改记录见包根目录 provenance/components.yaml。

04 同仓库更多 Skills