用途
llms-txt-generator 用于生成符合 llms.txt 标准、面向 AI/LLM 消费优化的结构化文档。当用户表达“crear llms.txt”“generate llms.txt”等意图时,应使用本技能。
主要能力
生成按领域组织的细粒度文档文件,输出结构如下:
llm-docs/
├── llm.txt # Main index (~1-2 KB)
├── llm.version.txt # Metadata and sync info (~0.3 KB)
└── llm.{domain}.txt # Domain-specific files (~3-50 KB each)
- llm.txt:主索引,包含项目元数据、快速参考、文档结构与阅读指南。
- llm.version.txt:元数据与同步信息。
- llm.{domain}.txt:按领域拆分的专属文件。
使用方式(工作流程)
阶段 1:语言选择
询问用户希望文档输出使用的语言(英语、西班牙语或双语)。
阶段 2:项目分析
识别项目类型与数据来源。项目类型判据包括:
- components/、设计令牌、SCSS → 前端/UI 库
- cmd/、CLI flags、subcommands → CLI 工具
- /api/、OpenAPI、routes → REST/GraphQL API
- src/、exports、package.json → 通用库
检测结构化数据源,包括:JSON 元数据文件(组件文档、OpenAPI 规范)、JSDoc/GoDoc 注释、TypeScript 定义、配置文件(package.json、go.mod)、既有文档(README、docs/)。
阶段 3:领域规划
根据项目类型规划要创建的 llm.{domain}.txt 文件:前端/UI 参见 references/frontend-example.md;CLI 工具参见 references/cli-example.md;API 参见 references/api-example.md;库参见 references/library-example.md。
阶段 4:实现方式决策
- 存在结构化数据(JSON、JSDoc、OpenAPI):创建生成脚本。
- 需要手动编写文档:编写静态 Markdown 文件。
- 混合来源:结构化部分用脚本,其余手动编写。
生成脚本结构参见 references/generator-script-pattern.md。
阶段 5:文件生成
依次生成 llm.version.txt(始终最先)、llm.txt(主索引)、llm.{domain}.txt(领域文件)。
llm.version.txt 示例结构:
# {Project} LLM Documentation
- **Version**: {semantic version}
- **Last Updated**: {YYYY-MM-DD}
- **Documentation Version**: 1.0.0
- **Files**: {count} domain files
- **Total Size**: ~{X} KB
llm.txt 主索引包含项目元数据(Name、Type、Language、Purpose)、快速参考(Key Modules、Patterns、Dependencies)、文档结构(各领域文件及其 Focus 与 Use when)、阅读指南(先读 llm.version.txt,再读主领域文件,按需参考其他文件)。
llm.{domain}.txt 领域文件结构包括 Overview(2-3 句说明该领域)、各章节(用表格列出 Name、Type、Description)、Related Files(说明关联文件及关联原因)。
最佳实践
- 文件大小:每个文件保持在 50 KB 以下,以获得最佳 LLM 上下文使用效果。
- 交叉引用:文件之间用清晰的“何时阅读”指引相互链接。
- 表格:对属性、令牌、参数使用 Markdown 表格。
- 代码示例:包含实用、可直接复制粘贴的示例。
- 层级:使用一致的标题级别(H1 为标题,H2 为章节,H3 为子章节)。
完整示例参见 references/complete-output-example.md。
适用场景
需要为项目生成 AI/LLM 可读的 llms.txt 文档,并按领域拆分组织时使用。适用于前端/UI 库、CLI 工具、REST/GraphQL API、通用库等类型的项目。
限制
关于具体收费、价格、平台支持范围等信息,资料未提供。