SuperAPI AI 工具集

workthrough

编程与开发

查看项目

更新于 10-15 18:41

技能介绍

该技能用于自动为开发工作生成结构化的 workthrough 文档,记录背景、所做修改与验证结果。适用时机为:实现新功能、修复 Bug、重构代码、修改配置、更新依赖、解决构建或编译问题,以及任何重要的代码改动之后。文档结构包括:标题、概述、所做修改、代码示例、验证结果。生成时需捕获完整上下文,说明要解决的问题、原有错误、采用的方法及决策原因;系统性地列出每个被修改文件的完整路径、改动内容、关键改动的前后代码片段、新增或移除的依赖及配置更新;展示代码示例时使用清晰格式;包含构建输出、测试结果、错误信息、退出码;使用 Markdown 标题、列表、带语法高亮的代码块与引用块排版。文档保存命名约定为 workthrough/YYYY-MM-DD-brief-description.md,也支持按功能或项目组织,例如 workthrough/feature-name/implementation.md、workthrough/bugfix/issue-123.md;若目录不存在需创建。质量要求是可供其他开发者阅读、包含验证步骤、可作为后续类似工作的参考,并记录重要决策与上下文;避免冗长描述、不必要术语、缺少验证步骤、含糊解释和不完整代码示例。该技能应在开发会话结束时自动触发,文档可用作开发日志、项目知识库、新人上手材料、调试参考与架构决策记录。