SuperAPI AI 工具集

miniproject

办公与效率

查看项目

更新于 10-16 02:06

技能介绍

用途

miniproject 是一个简化且简洁的项目管理与 AI 记忆框架,采用 Markdown 驱动任务管理(MDTM)方式,用于本地项目与知识管理。它把项目的所有管理信息与知识沉淀集中存放在一个 .memory/ 目录中,供 AI 代理或人按统一约定读写。

主要能力

  • 记忆存储:所有项目管理与知识文件必须存放在 .memory/ 目录,全部为 Markdown 格式。
  • 特殊文件:summary.md(项目概览、当前 epic、活跃阶段与下一里程碑)、todo.md(待办任务)、team.md(团队角色与当前正在处理的 epic/phase,用 session id 标识而非代理名)、knowledge-*.md(特定知识领域)。
  • 知识图谱:knowledge-codemap.md 存放以 ASCII 状态机图表示的代码库理解;knowledge-data-flow.md 存放数据流 ASCII 图。
  • 概念模型:Epic(愿景/目标)→ Stories(WHAT,与阶段无关的需求)与 Phases(WHEN,内联于 epic 文件中的阶段)→ Tasks(HOW + WHEN,同时链接 story_id 与 phase_id)。
  • 文件类型:research、epic、task、story、learning,以及 constitution、knowledge 等模板。
  • 归档:已完成的任务与 story 移入 .memory/archive/;learning 与 research 不归档;epic 需在所有阶段完成且提炼学习后才归档。
  • 辅助脚本:通过 miniproject.sh memory-dir 定位 .memory/ 目录,自动处理 git worktree(在主 worktree 中查找 .memory/)与普通 git 仓库,支持 --create 标志创建目录。

使用方式

开始任何工作前,先用辅助脚本找到记忆目录:

MEMORY_DIR=$(/home/zenobius/.pi/agent/skills/projectmanagement/miniproject/scripts/miniproject.sh memory-dir)

确保 .memory/ 中存在 todo.md、summary.md、knowledge.md、team.md(用 grep/ls 而非 glob 或 list 工具);若缺失则创建。若 knowledge-codemap.md 不存在,则创建并写入表示代码库理解的 ASCII 状态机图。开始工作前始终读取 summary.md、todo.md、team.md;始终更新 team.md 标明正在处理的 epic 与 phase 及处理者(用 session id);始终让 todo.md 保持最新。完成任务或阶段后提交变更,未经人工审查绝不推送。

搜索记忆时,因 .memory/ 可能被 gitignore,常规 List 与 Glob 工具可能失效,需使用 ripgrep 并加 --no-ignore:

rg --no-ignore "<search-term>" "$MEMORY_DIR/"

可用 rg -u 作为 --no-ignore 简写,rg -uu 同时搜索隐藏文件。

文件命名约定:除 summary.md 外,所有笔记须遵循 .memory/<type>-<8_char_hashid>-<title>.md,其中 type 为 research、epic、task、story、learning 之一,hashid 为唯一 8 字符哈希标识。不符合约定的文件须重命名、拆分或删除。

工作流:初始化 > 行动 > 停止。具体为:想法 > Epic 定义 > 研究 > Story 定义(含测试规范)> 阶段规划 > 人工审查 > 任务分解 > 停止;任务执行(含单元测试)> 学习提炼 > 重复;Story 完成 > 验证验收标准 + 测试覆盖门禁 > 阶段完成 > 学习提炼 > 人工审查 > 停止;Epic 完成 > Epic 总结与学习 > 人工审查 > 停止。

适用场景

适用于需要以本地 Markdown 文件管理项目、任务、需求与知识沉淀,并希望 AI 代理按统一约定读写项目记忆的场景。尤其适合使用 git worktree 的仓库,以及需要将需求(Story)与排期(Phase)分离管理、并通过 Task 双链接桥接的项目。

限制

  • .memory/ 可能被 gitignore,导致常规文件列举工具失效,必须使用 ripgrep --no-ignore。
  • 未经人工审查绝不推送变更。
  • 每个项目必须先有 epic 定义,才能创建 story 或 task。
  • Story 在 test_coverage 为 full(每条验收标准都有链接且通过的测试)之前不能标记完成。
  • 关于收费、价格、平台支持范围等事实,资料暂未提供。