SuperAPI AI 工具集

litho-document-skill

写作与研究

查看项目

更新于 10-16 10:21

技能介绍

用途:当用户要求生成项目文档、分析代码库架构、创建 C4 架构图或进行模块深度研究时使用。它是 Litho(deepwiki-rs)的纯 Agent 平行实现,不依赖任何外部二进制,完全通过 Agent 的工具调用能力自主完成文档生成流水线。\n\n主要能力:产出六类文档——概述.md(C4 Context 图、项目概述、业务价值)、架构.md(C4 Container/Component 图、架构模式、模块职责)、工作流.md(时序图、流程图、并发模型、错误处理)、Deep-Exploration/(每个领域模块的深度研究文档)、边界接口.md(CLI/API/配置等对外接口清单)、数据库概览.md(ER 图与表结构,条件触发)。\n\n使用方式:四阶段流水线为预处理→研究→编排→输出。预处理按项目规模分快速路径(小 <100 源文件递归读取;中 100-500 读入口+配置+README+语义搜索;大 >500 仅读 README、主配置、入口及 view_file_outline 与精确搜索)。研究阶段按 C1→C2→C3 并行执行,领域模块需全覆盖并按 DDD 分组,按 importance 评分分级分析。编排阶段按依赖顺序生成文档并分章节写入。输出阶段做 Mermaid 语法验证、置信度评分与执行摘要。工具使用优先级为 codebase_search、grep_search、view_file_outline、read_file、list_files。每步研究结果需持久化到 .litho-agent/ 临时目录,最终可删除。\n\n限制与注意:中间产物依赖临时目录管理,需处理上下文窗口限制;数据库文档仅在满足 .sql/.sqlproj、migrations/sql/db/database 目录、ORM 依赖或 DB 配置任一条件时触发,否则写极简声明文件。详细步骤见 references/ 下各阶段文档。具体收费、平台与效果暂未提供。