chore: import zh skill update-llms
This commit is contained in:
wehub-skill-sync
@@ -0,0 +1,9 @@
|
||||
# WeHub 来源说明
|
||||
|
||||
- Skill 名称：`update-llms`
|
||||
- 中文类目：维护仓库 llms.txt 文档导航
|
||||
- 上游仓库：`github__awesome-copilot`
|
||||
- 上游路径：`skills/update-llms/SKILL.md`
|
||||
- 上游链接：https://github.com/github/awesome-copilot/blob/HEAD/skills/update-llms/SKILL.md
|
||||
- 本仓库为 WeHub 中文 Skill 汉化包，基于 skill 市场筛选 Top200 清单整理
|
||||
- 原作者、版权和许可证信息以上游仓库为准
|
||||
@@ -0,0 +1,216 @@
|
||||
---
|
||||
name: update-llms
|
||||
description: '更新根文件夹中的 llms.txt 文件，以反映文档或规范的变更，遵循 https://llmstxt.org/ 上的 llms.txt 规范'
|
||||
---
|
||||
|
||||
# 更新 LLMs.txt 文件
|
||||
|
||||
更新仓库根目录下已有的 `llms.txt` 文件，以反映文档、规范或仓库结构的变更。该文件为大型语言模型（LLM）提供高级引导，帮助其找到理解仓库用途和规范的相关内容。
|
||||
|
||||
## 主要指令
|
||||
|
||||
更新已有的 `llms.txt` 文件，以保持准确性和对 llms.txt 规范的合规性，同时反映当前的仓库结构和内容。该文件必须保持针对 LLM 消费的优化，同时保持人类可读性。
|
||||
|
||||
## 分析与规划阶段
|
||||
|
||||
在更新 `llms.txt` 文件之前，你必须完成彻底的分析：
|
||||
|
||||
### 第 1 步：审查当前文件与规范
|
||||
- 阅读现有的 `llms.txt` 文件以了解当前结构
|
||||
- 查阅 https://llmstxt.org/ 上的官方规范，确保持续合规
|
||||
- 识别基于仓库变更可能需要更新的部分
|
||||
|
||||
### 第 2 步：仓库结构分析
|
||||
- 使用适当工具检查当前仓库结构
|
||||
- 将当前结构与现有 `llms.txt` 中记录的内容进行对比
|
||||
- 识别应纳入的新目录、文件或文档
|
||||
- 记录需要更新的已移除或已移动的文件
|
||||
|
||||
### 第 3 步：内容发现与变更检测
|
||||
- 识别新的 README 文件及其位置
|
||||
- 查找新的文档文件（`/docs/`、`/spec/` 等目录下的 `.md` 文件）
|
||||
- 定位新的规范文件及其用途
|
||||
- 发现新的配置文件及其相关性
|
||||
- 查找新的示例文件和代码样本
|
||||
- 识别对现有文档结构的任何变更
|
||||
|
||||
### 第 4 步：制定更新计划
|
||||
基于分析结果，制定包含以下内容的结构化计划：
|
||||
- 为保持准确性所需的变更
|
||||
- 需要添加到 llms.txt 的新文件
|
||||
- 需要移除或更新的过时引用
|
||||
- 为保持清晰度而进行的组织优化
|
||||
|
||||
## 实现要求
|
||||
|
||||
### 格式合规性
|
||||
更新后的 `llms.txt` 文件必须按照规范保持以下精确结构：
|
||||
|
||||
1. **H1 标题**：包含仓库/项目名称的单行（必需）
|
||||
2. **引用格式摘要**：以引用块格式呈现的简要描述（可选但推荐）
|
||||
3. **补充详情**：零个或多个无标题的 Markdown 章节，用于提供上下文
|
||||
4. **文件列表章节**：零个或多个 H2 章节，包含 Markdown 格式的链接列表
|
||||
|
||||
### 内容要求
|
||||
|
||||
#### 必需元素
|
||||
- **项目名称**：作为 H1 的清晰、描述性标题
|
||||
- **摘要**：解释仓库用途的简洁引用块
|
||||
- **关键文件**：按类别（H2 章节）组织的基本文件
|
||||
|
||||
#### 文件链接格式
|
||||
每个文件链接必须遵循：`[描述性名称](相对路径)：可选描述`
|
||||
|
||||
#### 章节组织
|
||||
将文件组织为逻辑性的 H2 章节，例如：
|
||||
- **文档**：核心文档文件
|
||||
- **规范**：技术规范和要求
|
||||
- **示例**：示例代码和使用示例
|
||||
- **配置**：安装和配置文件
|
||||
- **可选**：次要文件（特殊含义——可在较短上下文中跳过）
|
||||
|
||||
### 内容指南
|
||||
|
||||
#### 语言与风格
|
||||
- 使用简洁、清晰、无歧义的语言
|
||||
- 避免不加以解释的行话
|
||||
- 同时为人类和 LLM 读者编写
|
||||
- 描述要具体且信息丰富
|
||||
|
||||
#### 文件选择标准
|
||||
包含以下文件：
|
||||
- 解释仓库的用途和范围
|
||||
- 提供必要的技术文档
|
||||
- 展示使用示例和模式
|
||||
- 定义接口和规范
|
||||
- 包含配置和安装说明
|
||||
|
||||
排除以下文件：
|
||||
- 纯实现细节
|
||||
- 包含冗余信息
|
||||
- 构建产物或生成的内容
|
||||
- 与理解项目无关
|
||||
|
||||
## 执行步骤
|
||||
|
||||
### 第 1 步：当前状态分析
|
||||
1. 彻底阅读现有的 `llms.txt` 文件
|
||||
2. 完整检查当前仓库结构
|
||||
3. 将现有文件引用与实际仓库内容进行对比
|
||||
4. 识别过时、缺失或不正确的引用
|
||||
5. 记录当前文件中的任何结构性问题
|
||||
|
||||
### 第 2 步：内容规划
|
||||
1. 确定主要用途声明是否需要更新
|
||||
2. 根据需要审查并更新摘要引用块
|
||||
3. 规划新文件和目录的添加
|
||||
4. 规划过时或已移动内容的移除
|
||||
5. 根据需要重新组织章节以获得更好的清晰度
|
||||
|
||||
### 第 3 步：文件更新
|
||||
1. 更新仓库根目录下现有的 `llms.txt` 文件
|
||||
2. 保持对精确格式规范的合规性
|
||||
3. 添加新的文件引用并附上适当描述
|
||||
4. 移除或更新过时的引用
|
||||
5. 确保所有链接均为有效的相对路径
|
||||
|
||||
### 第 4 步：验证
|
||||
1. 验证对 https://llmstxt.org/ 规范的持续合规性
|
||||
2. 检查所有链接是否有效且可访问
|
||||
3. 确保该文件仍可作为有效的 LLM 导航工具
|
||||
4. 确认该文件仍同时具备人类可读性和机器可读性
|
||||
|
||||
## 质量保证
|
||||
|
||||
### 格式验证
|
||||
- ✅ 包含项目名称的 H1 标题
|
||||
- ✅ 引用格式摘要（如已包含）
|
||||
- ✅ 文件列表的 H2 章节
|
||||
- ✅ 正确的 Markdown 链接格式
|
||||
- ✅ 无损坏或无效的链接
|
||||
- ✅ 全文格式一致
|
||||
|
||||
### 内容验证
|
||||
- ✅ 清晰、无歧义的语言
|
||||
- ✅ 对必要文件的全面覆盖
|
||||
- ✅ 内容的逻辑组织
|
||||
- ✅ 适当的文件描述
|
||||
- ✅ 可作为有效的 LLM 导航工具
|
||||
|
||||
### 规范合规性
|
||||
- ✅ 严格遵循 https://llmstxt.org/ 格式
|
||||
- ✅ 使用必需的 Markdown 结构
|
||||
- ✅ 适当实现可选章节
|
||||
- ✅ 文件位于仓库根目录（`/llms.txt`）
|
||||
|
||||
## 更新策略
|
||||
|
||||
### 添加流程
|
||||
添加新内容时：
|
||||
1. 确定新文件所属的适当章节
|
||||
2. 为链接创建清晰、描述性的名称
|
||||
3. 编写简洁但信息丰富的描述
|
||||
4. 在章节内保持字母顺序或逻辑顺序
|
||||
5. 考虑是否为新的内容类型创建新章节
|
||||
|
||||
### 移除流程
|
||||
移除过时内容时：
|
||||
1. 确认文件确实已被移除或移动
|
||||
2. 检查已移动的文件是否应更新而非移除
|
||||
3. 若整个章节变空则将其删除
|
||||
4. 必要时更新交叉引用
|
||||
|
||||
### 重组流程
|
||||
重组内容时：
|
||||
1. 保持从一般到具体的逻辑流向
|
||||
2. 将基本文档保留在主章节中
|
||||
3. 将次要内容移至"可选"章节（如适当）
|
||||
4. 确保新的组织方式能改善 LLM 导航
|
||||
|
||||
`llms.txt` 的示例结构：
|
||||
|
||||
```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` 文件应满足以下条件：
|
||||
1. 准确反映当前仓库的结构和内容
|
||||
2. 保持对 llms.txt 规范的合规性
|
||||
3. 为基本文档提供清晰的导航
|
||||
4. 移除过时或不正确的引用
|
||||
5. 纳入新的重要文件和文档
|
||||
6. 保持逻辑组织，便于 LLM 消费
|
||||
7. 全文使用清晰、无歧义的语言
|
||||
8. 继续有效服务于人类和机器读者
|
||||
Reference in New Issue
Block a user