智能文档

文档 社区

技能解读

当前原文的自动摘译,尚未人工审校。

核心原则

渐进分析:逐步分析代码库,而不是一次性分析全部代码库 模式识别:识别常见的架构模式 C4 模型:遵循 C4 模型级别的结构文档 Mermaid 图:使用 Mermaid 进行所有可视化 Markdown 输出:生成结构良好的 Markdown 文件

第 2 阶段:架构分析(10-20 分钟)

目标:了解系统架构、模块和关系 步骤:识别模块/包: Rust:src/ 子目录、Cargo.toml 工作区成员 Python:具有 __init__.py 的顶级目录

流狐档案 运行与权限由流狐静态检查推断,不代表作者声明或实际测试结果。
领域
文档
作者声明的智能体
未找到明确声明;不据此推断已兼容或已测试
静态检查
85 / 100 · 启发式扫描,不代表运行安全
运行环境证据
未执行;当前没有隔离运行测试证据
作者 / 版本 / 许可证
@sopaco · 未声明许可证
上下文用量评级
低消耗
接入复杂程度
需简单配置
是否需要外部接口密钥
不需要
兼容的系统
macOS · Linux · Windows
运行环境要求
Node.js · Python
检测到的文件与系统行为
  • 只读
  • 允许写入 / 修改
网络行为
允许外网请求
安装命令数
无(仅作为资料)

需要注意: 未声明工具权限范围;实际权限由运行环境决定。;上游仓库已 206 天未更新,可能与最新智能体行为不一致。

01
第一阶段:项目发现(5-10 分钟)

目标:了解项目结构、技术堆栈和范围 步骤:获取项目概述:计算代码行数:识别入口点:

02
第 2 阶段:架构分析(10-20 分钟)

目标:了解系统架构、模块和关系 步骤:识别模块/包:Rust:`src/`子目录、`Cargo.toml`工作区成员 Python:具有`__init__.py`的顶级目录

03
第 3 阶段:文档生成(20-40 分钟)

目标:创建全面的Markdown文档创建`./docs/`目录结构:文档1:Project Overview.md内容结构:【主要组件的目录树】

04
第 4 阶段:图表生成(10-15 分钟)

要使用的 Mermaid 图类型: 系统上下文 - C4Context(如果可用,则使用 C4 插件语法,否则使用图形) 容器图 - C4Container 或部署图 组件关系 - 图形 TB/LR 序列图 - 用于工作流程

05
第 5 阶段:质量保证(5-10 分钟)

清单: [ ] 创建的所有 Markdown 文件 [ ] Mermaid 语法经过验证 [ ] 交叉引用工作 [ ] 文件结构逻辑

讨论

基于 GitHub Discussions。登录 GitHub 即可参与讨论、点赞、订阅更新。