🚀 快速安装
复制以下命令并运行，立即安装此 Skill：
npx @anthropic-ai/skills install github/awesome-copilot/create-llms💡 提示：需要 Node.js 和 NPM
根据仓库结构创建 llms.txt 文件
在仓库根目录中从头开始创建一个新的 llms.txt 文件，遵循 https://llmstxt.org/ 上的官方 llms.txt 规范。此文件为大型语言模型提供高级指导，说明在哪里可以找到用于理解仓库目的和规范的相关内容。
主要指令
创建一个全面的 llms.txt 文件，作为 LLM 有效理解和导航仓库的入口点。该文件必须符合 llms.txt 规范，并针对 LLM 消费进行优化，同时保持人类可读性。
分析与规划阶段
在创建 llms.txt 文件之前，您必须完成彻底的分析：
步骤 1：审阅 llms.txt 规范
- 在 https://llmstxt.org/ 上查看官方规范以确保完全合规
- 理解所需的格式结构和指南
- 注意特定的 markdown 结构要求
步骤 2：仓库结构分析
- 使用适当的工具检查完整的仓库结构
- 识别仓库的主要目的和范围
- 编录所有重要目录及其用途
- 列出对 LLM 理解有价值的关键文件
步骤 3：内容发现
- 识别 README 文件及其位置
- 查找文档文件（
/docs/、/spec/等目录中的.md文件） - 定位规范文件及其用途
- 发现配置文件及其相关性
- 查找示例文件和代码示例
- 识别任何现有的文档结构
步骤 4：创建实施计划
根据您的分析，创建一个结构化的计划，包括：
- 仓库目的和范围摘要
- 按优先级排序的、对 LLM 理解至关重要的文件列表
- 提供额外上下文的次要文件
- llms.txt 文件的组织结构
实施要求
格式合规性
llms.txt 文件必须遵循规范的以下确切结构：
- H1 标题：包含仓库/项目名称的单行（必需）
- 引用块摘要：引用块格式的简要描述（可选但推荐）
- 额外细节：零个或多个不带标题的 markdown 部分，用于提供上下文
- 文件列表部分：零个或多个 H2 部分，其中包含 markdown 链接列表
内容要求
必需元素
- 项目名称：作为 H1 的清晰、描述性标题
- 摘要：解释仓库目的的简洁引用块
- 关键文件：按类别组织的必要文件（H2 部分）
文件链接格式
每个文件链接必须遵循：[描述性名称](相对 URL)：可选描述
部分组织
将文件组织到逻辑性的 H2 部分中，例如：
- 文档：核心文档文件
- 规范：技术规范和需求
- 示例：示例代码和使用示例
- 配置：设置和配置文件
- 可选：次要文件（具有特殊含义——为缩短上下文可以跳过）
内容指南
语言和风格
- 使用简洁、清晰、无歧义的语言
- 避免不加解释地使用术语
- 为人类和 LLM 读者编写
- 在描述中要具体且信息丰富
文件选择标准
包括满足以下条件的文件：
- 解释仓库的目的和范围
- 提供必要的技术文档
- 展示使用示例和模式
- 定义接口和规范
- 包含配置和设置说明
排除满足以下条件的文件：
- 纯粹是实现细节
- 包含冗余信息
- 是构建工件或生成的内容
- 与理解项目无关
执行步骤
步骤 1：仓库分析
- 完全检查仓库结构
- 阅读主 README.md 以理解项目
- 识别所有文档目录和文件
- 编录规范文件及其用途
- 查找示例文件和配置文件
步骤 2：内容规划
- 确定主要目的陈述
- 为引用块编写简洁的摘要
- 将已识别的文件分组到逻辑类别中
- 按对 LLM 理解的重要性对文件进行优先级排序
- 为每个文件链接创建描述
步骤 3：文件创建
- 在仓库根目录中创建
llms.txt文件 - 遵循确切的格式规范
- 包含所有必需部分
- 使用正确的 markdown 格式
- 确保所有链接都是有效的相对路径
步骤 4：验证
- 验证是否符合 https://llmstxt.org/ 规范
- 检查所有链接是否有效且可访问
- 确保该文件能作为有效的 LLM 导航工具
- 确认该文件对人类和机器都可读
质量保证
格式验证
- ✅ 带有项目名称的 H1 标题
- ✅ 引用块摘要（如果包含）
- ✅ 用于文件列表的 H2 部分
- ✅ 正确的 markdown 链接格式
- ✅ 没有损坏或无效的链接
- ✅ 整个文件格式一致
内容验证
- ✅ 清晰、无歧义的语言
- ✅ 全面覆盖必要的文件
- ✅ 内容的逻辑组织
- ✅ 适当的文件描述
- ✅ 能作为有效的 LLM 导航工具
规范合规性
- ✅ 严格遵循 https://llmstxt.org/ 格式
- ✅ 使用必需的 markdown 结构
- ✅ 适当实施可选部分
- ✅ 文件位于仓库根目录（
/llms.txt）
示例结构模板
# [仓库名称]
> [关于仓库目的和范围的简洁描述]
[可选的、不带标题的额外上下文段落]
## 文档
- [主 README](README.md)：主要项目文档和入门指南
- [贡献指南](CONTRIBUTING.md)：为项目做出贡献的指南
- [行为准则](CODE_OF_CONDUCT.md)：社区指南和期望
## 规范
- [技术规范](spec/technical-spec.md)：详细的技术要求和约束
- [API 规范](spec/api-spec.md)：接口定义和数据契约
## 示例
- [基础示例](examples/basic-usage.md)：简单用法演示
- [高级示例](examples/advanced-usage.md)：复杂实现模式
## 配置
- [设置指南](docs/setup.md)：安装和配置说明
- [部署指南](docs/deployment.md)：生产部署指南
## 可选
- [架构文档](docs/architecture.md)：详细系统架构
- [设计决策](docs/decisions.md)：历史设计决策记录
成功标准
创建的 llms.txt 文件应：
- 使 LLM 能够快速理解仓库的目的
- 为必要的文档提供清晰的导航
- 严格遵循官方 llms.txt 规范
- 全面且简洁
- 有效地服务于人类和机器读者
- 包含所有理解项目所需的关键文件
- 通篇使用清晰、无歧义的语言
- 逻辑地组织内容以便于消费
📄 原始文档
完整文档（英文）：
https://skills.sh/github/awesome-copilot/create-llms
💡 提示：点击上方链接查看 skills.sh 原始英文文档，方便对照翻译。
声明：本站所有文章，如无特殊说明或标注，均为本站原创发布。任何个人或组织，在未征得本站同意时，禁止复制、盗用、采集、发布本站内容到任何网站、书籍等各类媒体平台。如若本站内容侵犯了原著者的合法权益，可联系我们进行处理。
评论(0)