工程开发
writing-skills avatar

writing-skills

一套用于代理程序流程文档测试驱动开发 (TDD) 的框架,让 AI 代理能通过子代理压力场景来验证与重构文档。

简介

Writing-skills 是一套专为软件工程代理程序设计的专业方法论,旨在将测试驱动开发 (TDD) 原则应用于其流程文档。通过将文档视为代码来处理,此技能可确保说明文档保持准确、可执行,并能对抗代理程序的误解。它专为需要管理复杂多步骤工作流,同时保持严格遵循项目标准的开发者与 AI 代理所设计。

此技能的核心是应用于文档的 RED-GREEN-REFACTOR 循环。代理程序不会编写静态指南,而是创建压力场景来测试自身对说明的理解。若代理程序在基准测试中违反规则 (RED),此技能要求更新文档以解决违规的根本原因。接着代理程序执行验证 (GREEN),确保文档能防止先前的失败。这种方法消除了模糊性,强化了清晰度,有效地将文档转变为可靠且可执行的参考系统。

  • 为技术文档与代理程序说明实现测试驱动开发 (TDD)。

  • 利用子代理压力场景模拟真实工作环境,实现自动化验证。

  • 执行迭代重构,以堵住漏洞并解决代理程序常见的偏差理由。

  • 提供强大的映射系统,确保文档与预期行为一致,防止长期项目中的行为漂移。

  • 标准化技能开发流程,包含 Frontmatter 规范与目录结构。

  • 当你需要教导代理程序一套可在多个项目中应用的可靠技术或模式时,请使用此技能。

  • 若代理程序无法遵守规则,请使用此技能来编码修复方案,并通过测试进行验证。

  • 非常适合用于记录复杂的系统模式、API 使用指南以及需要高度精确的工程工作流。

  • 在建立技能前,务必先进行基准检查以观察代理程序的失败模式,随后编写针对性的文档来填补这些差距。

  • 文档内容应精简并聚焦于触发条件,使用「Use when」句型来优化代理程序在执行任务时的搜索与检索效率。

  • 避免将此机制用于一次性任务;请将此流程保留给具备持久性与广泛适用性的工程技巧、模式或工具。

仓库统计

Star 数
170,784
Fork 数
15,077
Open Issue 数
285
主要语言
Shell
默认分支
main
同步状态
空闲
最近同步时间
2026年4月28日 11:24
在 GitHub 查看