SuperAPI AI 工具集

blueprints-organization

通用与其它

查看项目

更新于 10-16 03:38

技能介绍

用途:该资料用于管理技术蓝图文档的目录结构与避免重复。适用场景为维护 blueprints/ 下的实现文档,确保命名、索引与引用一致。

主要能力与建议:默认采用扁平结构,一个系统或功能一个 .md 文件;仅超大项目才按 core、features、integrations 等子目录划分。文件名用 kebab-case,与代码中系统或功能名保持一致,避免 utils.md、helpers.md 这类泛化命名。每个 blueprints/ 目录需有 README.md 作为索引,按系统、功能、集成分类列出链接,并说明新增蓝图时先检查已有文档、统一命名和结构、更新索引。

避免重复:创建前先用 Glob("blueprints/*.md") 列出文件,用 Grep("auth", path: "blueprints/", output_mode: "files_with_matches") 搜索相关主题,再 Read("blueprints/authentication.md") 确认覆盖情况;同一概念只保留一处,其他位置用链接引用。系统紧耦合或共享大量上下文时保持在一起,可独立理解、面向不同读者或文件超过约 500 行时拆分。重叠内容可选主位置加引用、共享章节或按系统范围内联。系统下线时应删除文件、更新索引并修复链接,历史交给版本控制。

限制:资料未提供该技能的安装方式、依赖工具、收费或许可信息;其中工具命令来自公开示例,实际可用性取决于运行环境。