mcpField
P
psi

psi

github.com/siviter-xyzAgent 工作流22141 次安装32 周前更新
代码仓库

关于 psi

psi 是用于规划、编写规格和实现软件变更的可选技能，并要求文档保持更新。各阶段可独立使用，规划阶段包含设计与审查，实现阶段采用测试优先方式。

主要功能

  1. 01规划、规格与实现阶段可独立使用
  2. 02计划和研究资料存于仓库外
  3. 03将规格应用到项目文档
  4. 04测试优先实现并进行 CI 检查
  5. 05规划阶段嵌入设计与审查

适用场景

  1. 01在实现前规划变更
  2. 02记录 API、架构或用户旅程
  3. 03在更新测试和文档的同时实现变更

安装

复制下面的命令，在终端中运行。

$npx skills add https://github.com/siviter-xyz/dot-agent --skill psi

安装后在 Claude Code 中输入/psi确认已加载。

包含的文件

除 SKILL.md 外，安装时一起下载的参考资料和脚本。

LICENSE
README.md
references/
docs-structure.md
file-paths.md
implement-phase.md
plan-phase.md
research-management.md
review-protocol.md
spec-phase.md
scripts/
get-plan-path.js
get-research-path.js
show-plan-location.js

详细介绍

PSI - 规划、规范、实现

采用文档优先的方法，以结构化工作流规划、规范和实现变更。

适用场景

仅在以下情况下使用：

  • 用户明确要求
  • 项目的 AGENTS.md 文件中提及

不要自动使用 —— 这是一个可选工作流，并非默认流程。

核心工作流

规划 → 规范 → 实现

各阶段相互独立——你可以从任意阶段开始，但所有阶段都必须确保文档保持最新。

关键原则

  1. 临时规划 - 计划存储在 ~/.dot-agent/ 中（不提交）
  2. 文档优先 - 将规范应用到项目文档、README 和 AGENTS.md
  3. 测试优先实现 - 编写代码前，先为文档和用户旅程编写测试
  4. 嵌入设计与审查 - 在规划和规范阶段集成设计与审查
  5. 阶段相互独立 - 各阶段均可独立运行，但都会更新文档

阶段概览

规划阶段
  • 在 ~/.dot-agent/repo/YYYY-MM-work-name.plan.md 中生成详细计划
  • 将调研内容存储在 ~/.dot-agent/working-dir/repo/YYYY-MM-work-name.research.md 中
  • 嵌入设计考量
  • 继续之前进行审查
规范阶段
  • 为以下内容生成规范：API 架构、接口、DTO、数据库模型、配置、环境变量、架构、用户旅程、包结构、技术选型
  • 嵌入设计考量
  • 应用前审查规范
  • 应用到：docs/、README.md 文件、AGENTS.md 文件
实现阶段
  • 测试优先：编写代码前，先为文档和用户旅程编写测试
  • CI 验证：提交前验证类型检查、测试和 lint 均通过
  • 原子提交：将相关变更与测试分组
  • 随着代码演进更新文档、README.md 和 AGENTS.md
  • 如果文档中已有规范，也可以独立开展

调研管理

识别类似以下的表达：

  • “查看你的调研” → 加载调研文件
  • “完善你的调研” → 更新调研文件并缩小范围

文档结构

  • README.md：建议少于 1000 行（非硬性规定），必要时可以更长
  • AGENTS.md：少于 200 行，可内联放置于根目录、包、模块或代码级别
  • docs/：架构、路线图、技术选型、setup/、user-journeys/、design/

参考资料

详细流程请参阅：

  • references/plan-phase.md - 生成计划并嵌入设计与审查
  • references/spec-phase.md - 生成并应用规范
  • references/implement-phase.md - 测试优先实现
  • references/review-protocol.md - 审查计划、规范和设计
  • references/research-management.md - 调研文件处理
  • references/docs-structure.md - 文档组织规则
  • references/file-paths.md - 存储路径和约定

评论

支持 Markdown