SuperAPI AI 工具集

structured-content-storage

智能体与模型

查看项目

更新于 10-15 21:46

技能介绍

用途:该技能为代码与数据项目强制实施结构化、文档充分的存储标准,确保创建的或处理的内容遵循严格的目录组织与文档规范。

适用任务:编写机器学习训练脚本、创建数据处理或清洗脚本、开发任何处理或转换数据的代码、修改已有的结构化项目、创建分析脚本或计算工作流、构建数据管道或ETL流程,以及其他会产出文件或处理数据的代码创建任务。

核心能力:一是结构化目录布局,包含README.md、src/、data/(raw、processed、DATA_DICTIONARY.md)、docs/(PROCESS.md、CHANGELOG.md)、outputs/、requirements.txt等;二是代码文档标准,每个函数需有说明用途、参数、返回值的docstring,复杂逻辑需行内注释解释原因,文件头需描述用途与主要组件,魔术数字需解释或转为命名常量;三是必备文档文件,README.md需含项目目的、目录说明、安装与用法、依赖,PROCESS.md需含逐步工作流、数据流图、关键决策与理由、预期输入输出,DATA_DICTIONARY.md需含字段名、类型、描述、取值范围与约束、数据来源与采集方式、更新频率,CHANGELOG.md需含日期与版本、变更内容与原因、受影响文件、破坏性变更或迁移说明;四是修改协议,修改已有结构化项目时需先阅读理解原结构,保持既有组织模式,更新所有受影响文档,在CHANGELOG.md中添加详细条目,更新被修改代码段的注释。

使用方式:在涉及上述代码创建或数据处理的请求中调用本技能,按对应项目类型(如ML训练项目、数据清洗项目)套用标准结构,按注释模板与CHANGELOG条目模板撰写文档。

限制:不适用于纯对话查询、不产出代码的读取或分析、不影响项目结构的单行修复;不强制特定编码风格(如PEP8);若修改已有项目,必须先阅读并理解原结构。资料未提供安装命令、收费、价格或平台信息。