project-understanding
其他 活跃维护

project-understanding

guchengyouzi12138/project-understanding

支持读取Axure原型文件,提供Harness与Skill双版本可选,自动梳理项目功能逻辑与业务模块,新人入职无需逐份翻阅文档即可快速上手现有项目。

0
Stars 标星
0
Forks 分支
0
Watchers 关注
0
Open Issues
JavaScript
主要语言
MIT
开源协议
27 KB
仓库大小
1 个月前
最后推送
一键安装扩展 / 插件指令
dsh plugin --profile web add github:guchengyouzi12138/project-understanding
git clone https://github.com/guchengyouzi12138/project-understanding.git
git clone git@github.com:guchengyouzi12138/project-understanding.git
README.md main

Project Understanding(项目理解工具)

一键「读懂项目并生成理解报告」的能力,支持四种输入:

路径 输入 处理方式
路径 1 Axure .rp 原型 Python 转结构化 JSON(自动识别 ZIP / 二进制两种格式)→ 报告
路径 2 前端代码 递归读取代码文件 → 报告
路径 3 后端代码 递归读取代码文件 → 报告
路径 4 网站链接 抓取网页内容 → 分析 → 报告

多种输入一次给入时,逐条处理,最终合并输出一篇统一报告

本仓库提供同一能力的三种交付形态:

版本 目录 说明 适用场景
harness 动态插件 harness-plugin/ 动态 Cordis 插件,注册 rp_extract / code_ingest / url_fetch 三个模型工具 当前 harness 会话内即装即用
寻常 skill skill/ 一份 SKILL.md 指令 + 自带 Python 脚本 任何支持 skill 的环境,用内置工具完成同样的事
常驻 preset preset/ 一个 agent preset(Cordis 组合),把三个工具固化成常驻能力 每次会话自动加载,无需手动安装

三者共享同一套 Axure 解析逻辑(axure_extract.py),只是封装方式不同:动态插件把逻辑编成「工具」,skill 把逻辑写成「指令」,preset 把它固化成「组合」。

目录结构

project-understanding/
├── README.md                              # 本文件
├── harness-plugin/                        # 版本一:harness 动态插件
│   ├── project-understanding.host.js      #   插件宿主代码(自包含,内嵌 Python)
│   └── README.md
├── skill/                                 # 版本二:寻常 skill
│   ├── SKILL.md
│   ├── scripts/axure_extract.py
│   └── README.md
└── preset/                                # 版本三:常驻 preset
    ├── project-understanding.cjs          #   preset 插件(自包含,内嵌 Python)
    ├── agent.cordis.yml                   #   preset 组合(standard + 本插件)
    ├── preset.yml                         #   显示元数据
    └── README.md

核心产物

axure_extract.py —— 唯一的 Python 依赖,支持两种 .rp 格式:

  • ZIP(RP8 / 旧版 9):读 document.json / document.js
  • 二进制(RP9/10):解压 gzip/zlib 数据块,还原中文文本。

用法:python axure_extract.py <input.rp> <output.json> [--stdout] [--dump-raw]