LLM 文档索引生成器
将项目 Wiki 转换为符合 llms.txt 规范的 LLM 友好文档索引。
技能要求先解析 git remote、分支并询问仓库来源,且禁止覆盖非 deep-wiki 生成的根 llms.txt,体现了一定的范围控制与用户确认;但未说明敏感数据处理、外部数据流、备份回滚或链接安全校验,因此扣分。
指令结构基本一致,包含前置解析、格式规则、前置条件和验证清单;但没有可执行脚本、依赖说明、异常输入处理或失败反馈设计,且关键生成过程依赖代理自行推断,因此静态评估不超过10分。
触发条件和主要使用场景较明确,覆盖 llms.txt、llms-full.txt、LLM-friendly 文档等请求;但非适用边界、不同仓库结构、中文文档支持及中国大陆网络可达性均未充分说明,因此扣分。
文档采用渐进式结构,提供元数据、格式示例、前置条件、输出文件和验证清单,并声明 MIT 许可证与版本1.0.0;但缺少变更记录、明确维护责任、更新路径、安装依赖和故障排查,因此扣分。
目标文件、结构、链接规则和校验项目较具体,理论上可完成核心任务;但没有真实代表性输出或关键路径复现证据,且复杂 wiki、缺失页面和已有文件场景仍需较多代理判断,因此静态评估不超过7分。
提供 llms.txt 规范链接、明确规则和验证清单,具备有限的审计依据;但未提供该技能专属测试、提交输出或第三方执行证据,结论主要来自文档声明,因此静态评估不超过5分。
- 该技能要求执行 git 命令并询问仓库来源,但未定义命令失败、无远程仓库或分支检测失败时的处理方式。
- 生成内容可能读取整个 wiki;未说明如何避免将密钥、内部链接或其他敏感信息写入 llms-full.txt。
- 验证清单仅由代理执行,缺少自动化测试和可复现样例,发布前应人工检查链接、内容完整性和覆盖范围。
- 依赖 llmstxt.org 规范说明;规范或相关网络服务不可达时,技能未提供本地规范副本或替代流程。
它能做什么 & 适用场景
这是 Microsoft Agent Skills 仓库中的一个文档生成技能,专门生成 llms.txt 和 llms-full.txt。它面向希望让项目 Wiki 更易被语言模型读取的开发者和文档维护者。技能会先解析源代码仓库上下文,再根据实际 Wiki 页面生成索引和完整内联文档。它属于深度 Wiki 插件的一部分,并不负责一般的 Azure SDK 开发。
首先运行 git remote get-url origin 和 git rev-parse --abbrev-ref HEAD,以解析源仓库地址和默认分支,并要求用户确认仓库是本地仓库还是具有源仓库 URL。随后读取已有 Wiki 页面,生成根目录 ./llms.txt、wiki/llms.txt 和 wiki/llms-full.txt;索引文件包含相对链接和页面摘要,完整文件以内联方式保存页面内容,并去除 YAML frontmatter、保留 Mermaid 图表、引用、表格和 Sources 注释。若没有 Wiki 页面,可建议先运行 /deep-wiki:generate,或根据 README 与源代码扫描生成不含 Wiki 页面链接的最小索引。若根目录已有非 deep-wiki 生成的 llms.txt,则不覆盖。
- 维护项目 Wiki 的开发团队,希望提供一个标准入口供语言模型发现文档。
- 使用深度 Wiki 生成器后,需要把多个 Wiki 页面汇总为 llms.txt 和完整上下文文件的文档维护者。
- 希望将项目文档部署到 VitePress,并需要 wiki/llms.txt 相对链接的团队。
- 需要把 Mermaid 图表、引用、表格和页面正文集中提供给代码代理或其他文档代理的工程团队。
优缺点一览
- 输出根目录和 Wiki 目录两套索引,适合标准发现路径与 VitePress 导航。
- 明确保留 Mermaid 图表、引用、表格和来源注释,适合完整文档上下文。
- 包含链接存在性、空文档块、重复页面和内容长度等验证清单。
- MIT 许可,且 README 表明仓库持续维护并扩展测试。
- 依赖已存在的 Wiki 页面才能发挥完整能力;否则只能生成基于 README 和源代码扫描的最小版本。
- 必须先完成仓库上下文解析,并要求用户确认仓库类型;未解析完成前不能继续。
- 源材料没有提供该单个技能的独立测试覆盖或具体运行时版本要求。
- 会写入多个文档文件;已有非 deep-wiki 根 llms.txt 不会被覆盖。
如何安装
仓库 README 支持运行 npx skills add microsoft/skills,然后在向导中选择所需技能;技能会安装到所选代理的目录,例如 GitHub Copilot 使用 .github/skills/。作为插件,也可在 Copilot CLI 中运行 /plugin marketplace add microsoft/skills 和 /plugin install deep-wiki@skills。源材料没有说明单独安装 wiki-llms-txt 文件夹的命令。
如何使用
在已安装该技能且 Wiki 页面可用的项目中,提出“生成 llms.txt 和 llms-full.txt”或“让项目文档符合 llms.txt 标准”等请求。技能开始前会要求确认本地仓库或源仓库 URL,并解析 Git 远程地址和当前分支;若没有 Wiki,先运行 /deep-wiki:generate 或 /deep-wiki:page。