SuperAPI AI 工具集

document

写作与研究

查看项目

更新于 10-15 10:05

技能介绍

用途

Documentation Skill 是 S3Mock 项目中的文档技能,用于生成或更新项目文档。当被要求为代码编写文档、创建文档、解释功能,或修复现有文档中的格式、措辞、风格问题时使用。

主要能力

该技能定义了项目中的文档文件及其受众与用途:

  • README.md:面向最终用户,包含用法、配置、操作表。
  • CHANGELOG.md:面向最终用户,包含版本历史、破坏性变更。
  • docs/TESTING.md:面向贡献者 / AI 智能体,包含测试策略、基类、模式、命令。
  • docs/KOTLIN.md:面向贡献者 / AI 智能体,包含 Kotlin 惯用法、命名约定、反模式、KDoc。
  • docs/SPRING.md:面向贡献者 / AI 智能体,包含 Spring Boot 模式、依赖注入、控制器、异常处理。
  • docs/JAVA.md:面向贡献者 / AI 智能体,包含 Java 惯用法、命名约定、反模式、Javadoc。
  • AGENTS.md(根目录 + 各模块):面向 AI 智能体,包含架构、约定、护栏。
  • .github/CONTRIBUTING.md:面向贡献者,包含开发环境搭建、代码审查。

使用方式

改动前需先阅读 AGENTS.md(根目录 + 相关模块)。技能给出了不同变更类型对应的更新范围:

  • 新增 S3 操作:更新 README.md 中的操作表(:x: → :white_check_mark:)、CHANGELOG.md;若引入新模式,更新 server/AGENTS.md。
  • 配置变更:更新 README.md 中的配置表、AGENTS.md 中的配置章节、CHANGELOG.md。
  • 架构变更:更新相关模块的 AGENTS.md;若为跨领域变更,更新根目录 AGENTS.md;更新 CHANGELOG.md。
  • Spring Boot 模式变更:更新 docs/SPRING.md;若变更影响控制器 / 服务 / 存储的结构方式,更新 server/AGENTS.md。
  • Kotlin/Java 风格变更:更新 docs/KOTLIN.md 或 docs/JAVA.md;若引入新的护栏,更新根目录 AGENTS.md 的 DO/DON'T 章节。

CHANGELOG 格式:遵循现有模式,按当前版本标题分组,使用清晰的面向用户语言,标注破坏性变更,引用 issue/PR。

风格要求:简洁、主动语态;包含可运行示例(API 用 Kotlin,CLI 用 shell);链接到 AWS S3 API 文档;匹配现有格式。

检查清单:对照源代码验证技术准确性;确保链接和代码示例有效;匹配周围的风格与格式。

适用场景

适用于 S3Mock 项目的文档编写与维护,包括新增功能后的文档同步、配置与架构变更后的文档更新,以及文档格式、措辞、风格的修正。

限制

该技能的具体安装命令、收费方式、平台支持等信息暂未提供。