SuperAPI AI 工具集

project-knowledge-hierarchy

办公与效率

查看项目

更新于 10-16 05:10

技能介绍

用途

项目知识库分层维护技能用于为项目建立标准化的文档目录结构,将项目知识按四层模型组织,便于长期维护与检索。

四层架构

  • 项目层(Project Layer):业务方向、核心流程、架构设计、决策记录。
  • 技术层(Technology Layer):中间件、数据库设计、编码规范、第三方库、接口文档。
  • 资产层(Assets Layer):产品需求、技术方案、测试用例、Bug 记录。
  • 原始层(Raw Assets):会议纪要、网页、聊天记录、录音转写等原始信息。

前三层遵循单向依赖原则:上层文档可引用下层文档,禁止反向依赖。原始层不属于 docs/ 三层结构的正式目录,是上层文档的信息源头,原始材料经提炼后才能进入正式层级。

主要能力

  • 生成四层标准化目录结构,docs/ 下采用中文目录命名。
  • 为每个目录创建 index.md 索引文件,即使空目录也保留空索引表。
  • 为业务文档提供 YAML 元数据规范,包含核心 6 字段(文档编号、标题、类型、状态、日期、作者)与推荐 2 字段(描述、标签)。
  • 提供原始层 README.md 层说明模板,原始层不建 index.md。
  • 支持增量维护:目录已存在时仅创建缺失部分,不覆盖已有 index.md。
  • 提供参考文件路由表,按需加载目录结构、原始层说明、增量维护指引、维护规范、OKF 对齐等主题。

使用方式

技能按以下步骤执行:

  1. 询问目录位置,默认在当前工程的 docs 目录下创建。
  2. 检查已有目录,若存在则进入增量模式,只创建缺失的子目录,不覆盖已有 index.md。
  3. 选择生成模式:完整模式(推荐,含原始层)/ 单层模式 / 自定义模式 / 原始层模式;无明确选择时默认完整模式。
  4. 创建目录结构,使用 mkdir -p 确保幂等。完整模式示例:
mkdir -p docs/01-项目层/{01-项目概览,02-核心流程,03-架构设计,04-决策记录}
mkdir -p docs/02-技术层/{01-中间件配置,02-数据库设计,03-编码规范,04-第三方库,05-接口文档}
mkdir -p docs/03-资产层/{01-产品需求,02-技术方案,03-测试用例,04-Bug记录}

原始层按来源类型初始化子目录,示例:

mkdir -p docs/04-原始层/{01-会议记录,02-网页资料,03-聊天记录,04-录音转写,05-其他杂项}
  1. 初始化 index.md 文件,仅在不存在时创建。
  2. 新建业务文档时复制标准模板,替换占位符,生成描述与标签,编写正文,并在所属子目录 index.md 的文档清单表格中追加对应行。

生成模式

  • 完整模式(推荐):生成全部四层结构,含 13 个三层子目录、3 个层级 index.md、13 个子目录 index.md、原始层目录及 README.md。
  • 单层模式:只生成指定层级。
  • 自定义模式:用户勾选需要的子目录。
  • 原始层模式:仅初始化原始层。

适用场景

适用于需要长期维护项目知识、希望统一文档目录结构与元数据规范的项目团队,尤其适合需要区分正式文档与原始材料来源的场景。

限制

  • 原始层存储位置由项目自定,技能提供四种推荐方案,具体选择需项目决定。
  • 原始层下的目录不创建 index.md,仅创建 README.md。
  • 文档编号需全局唯一,格式为 DOC-{层级编码}-{子目录序号}-{3 位序号}。
  • 层级编码:项目层 PRJ、技术层 TECH、资产层 AST。
  • 扩展可选字段(resource / sources / stale_after)借鉴自 OKF v0.2,仅在场景需要时启用。
  • 具体模板内容、子目录职责一览、OKF 对齐指引等详见对应参考文件,本介绍未展开的部分以技能内参考文件为准。