update-llms
Compare original and translation side by side
🇺🇸
Original
English🇨🇳
Translation
ChineseUpdate LLMs.txt File
更新LLMs.txt文件
Update the existing file in the root of the repository to reflect changes in documentation, specifications, or repository structure. This file provides high-level guidance to large language models (LLMs) on where to find relevant content for understanding the repository's purpose and specifications.
llms.txt更新仓库根目录下已有的文件,以反映文档、规格说明或仓库结构的变更。该文件为大语言模型(LLMs)提供高层级指引,帮助其找到理解仓库用途和规格说明的相关内容。
llms.txtPrimary Directive
核心要求
Update the existing file to maintain accuracy and compliance with the llms.txt specification while reflecting current repository structure and content. The file must remain optimized for LLM consumption while staying human-readable.
llms.txt更新现有的文件,在反映当前仓库结构和内容的同时,保持准确性并符合llms.txt规范。文件必须在保持人类可读性的同时,优化LLM的使用体验。
llms.txtAnalysis and Planning Phase
分析与规划阶段
Before updating the file, you must complete a thorough analysis:
llms.txt在更新文件前,必须完成全面分析:
llms.txtStep 1: Review Current File and Specification
步骤1:审查当前文件与规范
- Read the existing file to understand current structure
llms.txt - Review the official specification at https://llmstxt.org/ to ensure continued compliance
- Identify areas that may need updates based on repository changes
- 读取现有的文件,理解当前结构
llms.txt - 查阅https://llmstxt.org/上的官方规范,确保持续合规
- 根据仓库变更确定可能需要更新的区域
Step 2: Repository Structure Analysis
步骤2:仓库结构分析
- Examine the current repository structure using appropriate tools
- Compare current structure with what's documented in existing
llms.txt - Identify new directories, files, or documentation that should be included
- Note any removed or relocated files that need to be updated
- 使用合适的工具检查当前仓库结构
- 将当前结构与现有中记录的内容进行对比
llms.txt - 识别应纳入的新目录、文件或文档
- 记录需要更新的已移除或已迁移文件
Step 3: Content Discovery and Change Detection
步骤3:内容发现与变更检测
- Identify new README files and their locations
- Find new documentation files (files in
.md,/docs/, etc.)/spec/ - Locate new specification files and their purposes
- Discover new configuration files and their relevance
- Find new example files and code samples
- Identify any changes to existing documentation structure
- 识别新的README文件及其位置
- 查找新的文档文件(如、
/docs/等目录下的/spec/文件).md - 定位新的规格说明文件及其用途
- 发现新的配置文件及其相关性
- 查找新的示例文件和代码样本
- 识别现有文档结构的任何变更
Step 4: Create Update Plan
步骤4:制定更新计划
Based on your analysis, create a structured plan that includes:
- Changes needed to maintain accuracy
- New files to be added to the llms.txt
- Outdated references to be removed or updated
- Organizational improvements to maintain clarity
基于你的分析,制定结构化计划,包括:
- 为保持准确性所需的变更
- 需添加到llms.txt的新文件
- 需移除或更新的过时引用
- 为保持清晰性而进行的架构优化
Implementation Requirements
实施要求
Format Compliance
格式合规性
The updated file must maintain this exact structure per the specification:
llms.txt- H1 Header: Single line with repository/project name (required)
- Blockquote Summary: Brief description in blockquote format (optional but recommended)
- Additional Details: Zero or more markdown sections without headings for context
- File List Sections: Zero or more H2 sections containing markdown lists of links
更新后的文件必须严格遵循以下规范结构:
llms.txt- H1标题:单行的仓库/项目名称(必填)
- 块引用摘要:块引用格式的简要描述(可选但推荐)
- 附加详情:零个或多个无标题的Markdown段落,用于提供上下文
- 文件列表章节:零个或多个包含Markdown链接列表的H2章节
Content Requirements
内容要求
Required Elements
必填元素
- Project Name: Clear, descriptive title as H1
- Summary: Concise blockquote explaining the repository's purpose
- Key Files: Essential files organized by category (H2 sections)
- 项目名称:清晰、描述性的标题,以H1格式呈现
- 摘要:解释仓库用途的简洁块引用
- 关键文件:按类别(H2章节)组织的核心文件
File Link Format
文件链接格式
Each file link must follow:
[descriptive-name](relative-url): optional description每个文件链接必须遵循:
[描述性名称](相对路径): 可选描述Section Organization
章节组织
Organize files into logical H2 sections such as:
- Documentation: Core documentation files
- Specifications: Technical specifications and requirements
- Examples: Sample code and usage examples
- Configuration: Setup and configuration files
- Optional: Secondary files (special meaning - can be skipped for shorter context)
将文件组织到逻辑H2章节中,例如:
- Documentation(文档):核心文档文件
- Specifications(规格说明):技术规格说明与要求
- Examples(示例):示例代码与使用示例
- Configuration(配置):安装与配置文件
- Optional(可选):次要文件(特殊含义 - 如需更简短的上下文可跳过)
Content Guidelines
内容指南
Language and Style
语言与风格
- Use concise, clear, unambiguous language
- Avoid jargon without explanation
- Write for both human and LLM readers
- Be specific and informative in descriptions
- 使用简洁、清晰、明确的语言
- 避免无解释的行话
- 同时面向人类和LLM读者写作
- 描述要具体且信息丰富
File Selection Criteria
文件选择标准
Include files that:
- Explain the repository's purpose and scope
- Provide essential technical documentation
- Show usage examples and patterns
- Define interfaces and specifications
- Contain configuration and setup instructions
Exclude files that:
- Are purely implementation details
- Contain redundant information
- Are build artifacts or generated content
- Are not relevant to understanding the project
纳入以下文件:
- 解释仓库用途与范围的文件
- 提供核心技术文档的文件
- 展示使用示例与模式的文件
- 定义接口与规格说明的文件
- 包含配置与安装说明的文件
排除以下文件:
- 纯实现细节类文件
- 包含冗余信息的文件
- 构建产物或生成内容
- 与理解项目无关的文件
Execution Steps
执行步骤
Step 1: Current State Analysis
步骤1:当前状态分析
- Read the existing file thoroughly
llms.txt - Examine the current repository structure completely
- Compare existing file references with actual repository content
- Identify outdated, missing, or incorrect references
- Note any structural issues with the current file
- 仔细阅读现有的文件
llms.txt - 全面检查当前仓库结构
- 将现有文件引用与实际仓库内容进行对比
- 识别过时、缺失或错误的引用
- 记录当前文件存在的任何结构问题
Step 2: Content Planning
步骤2:内容规划
- Determine if the primary purpose statement needs updates
- Review and update the summary blockquote if needed
- Plan additions for new files and directories
- Plan removals for outdated or moved content
- Reorganize sections if needed for better clarity
- 判断主用途说明是否需要更新
- 若需要,审查并更新摘要块引用
- 规划新增文件和目录的添加内容
- 规划过时或已迁移内容的移除方案
- 若需要,重新组织章节以提升清晰度
Step 3: File Updates
步骤3:文件更新
- Update the existing file in the repository root
llms.txt - Maintain compliance with the exact format specification
- Add new file references with appropriate descriptions
- Remove or update outdated references
- Ensure all links are valid relative paths
- 更新仓库根目录下的现有文件
llms.txt - 严格遵循格式规范
- 添加带有适当描述的新文件引用
- 移除或更新过时引用
- 确保所有链接均为有效的相对路径
Step 4: Validation
步骤4:验证
- Verify continued compliance with https://llmstxt.org/ specification
- Check that all links are valid and accessible
- Ensure the file still serves as an effective LLM navigation tool
- Confirm the file remains both human and machine readable
- 验证是否持续符合https://llmstxt.org/的规范
- 检查所有链接是否有效且可访问
- 确保文件仍可作为有效的LLM导航工具
- 确认文件同时保持人类与机器可读性
Quality Assurance
质量保证
Format Validation
格式验证
- ✅ H1 header with project name
- ✅ Blockquote summary (if included)
- ✅ H2 sections for file lists
- ✅ Proper markdown link format
- ✅ No broken or invalid links
- ✅ Consistent formatting throughout
- ✅ 包含项目名称的H1标题
- ✅ 块引用摘要(若包含)
- ✅ 用于文件列表的H2章节
- ✅ 正确的Markdown链接格式
- ✅ 无损坏或无效链接
- ✅ 全程格式一致
Content Validation
内容验证
- ✅ Clear, unambiguous language
- ✅ Comprehensive coverage of essential files
- ✅ Logical organization of content
- ✅ Appropriate file descriptions
- ✅ Serves as effective LLM navigation tool
- ✅ 清晰、明确的语言
- ✅ 全面覆盖核心文件
- ✅ 逻辑化的内容组织
- ✅ 合适的文件描述
- ✅ 可作为有效的LLM导航工具
Specification Compliance
规范合规性
- ✅ Follows https://llmstxt.org/ format exactly
- ✅ Uses required markdown structure
- ✅ Implements optional sections appropriately
- ✅ File located at repository root ()
/llms.txt
- ✅ 严格遵循https://llmstxt.org/的格式
- ✅ 使用要求的Markdown结构
- ✅ 合理使用可选章节
- ✅ 文件位于仓库根目录()
/llms.txt
Update Strategy
更新策略
Addition Process
新增流程
When adding new content:
- Identify the appropriate section for new files
- Create clear, descriptive names for links
- Write concise but informative descriptions
- Maintain alphabetical or logical ordering within sections
- Consider if new sections are needed for new content types
添加新内容时:
- 确定新文件所属的合适章节
- 为链接创建清晰、描述性的名称
- 编写简洁且信息丰富的描述
- 在章节内保持字母顺序或逻辑顺序
- 考虑是否需要为新内容类型创建新章节
Removal Process
移除流程
When removing outdated content:
- Verify files are actually removed or relocated
- Check if relocated files should be updated rather than removed
- Remove entire sections if they become empty
- Update cross-references if needed
移除过时内容时:
- 验证文件是否确实已移除或迁移
- 检查已迁移文件是否应更新而非移除
- 若章节变为空则移除整个章节
- 必要时更新交叉引用
Reorganization Process
重组流程
When restructuring content:
- Maintain logical flow from general to specific
- Keep essential documentation in primary sections
- Move secondary content to "Optional" section if appropriate
- Ensure new organization improves LLM navigation
Example structure for :
llms.txttxt
undefined重构内容时:
- 保持从通用到具体的逻辑流程
- 将核心文档保留在主要章节中
- 若合适,将次要内容移至“可选”章节
- 确保新的架构能提升LLM导航体验
llms.txttxt
undefined[Repository Name]
[Repository Name]
[Concise description of the repository's purpose and scope]
[Optional additional context paragraphs without headings]
[Concise description of the repository's purpose and scope]
[Optional additional context paragraphs without headings]
Documentation
Documentation
- Main README: Primary project documentation and getting started guide
- Contributing Guide: Guidelines for contributing to the project
- Code of Conduct: Community guidelines and expectations
- Main README: Primary project documentation and getting started guide
- Contributing Guide: Guidelines for contributing to the project
- Code of Conduct: Community guidelines and expectations
Specifications
Specifications
- Technical Specification: Detailed technical requirements and constraints
- API Specification: Interface definitions and data contracts
- Technical Specification: Detailed technical requirements and constraints
- API Specification: Interface definitions and data contracts
Examples
Examples
- Basic Example: Simple usage demonstration
- Advanced Example: Complex implementation patterns
- Basic Example: Simple usage demonstration
- Advanced Example: Complex implementation patterns
Configuration
Configuration
- Setup Guide: Installation and configuration instructions
- Deployment Guide: Production deployment guidelines
- Setup Guide: Installation and configuration instructions
- Deployment Guide: Production deployment guidelines
Optional
Optional
- Architecture Documentation: Detailed system architecture
- Design Decisions: Historical design decision records
undefined- Architecture Documentation: Detailed system architecture
- Design Decisions: Historical design decision records
undefinedSuccess Criteria
成功标准
The updated file should:
llms.txt- Accurately reflect the current repository structure and content
- Maintain compliance with the llms.txt specification
- Provide clear navigation to essential documentation
- Remove outdated or incorrect references
- Include new important files and documentation
- Maintain logical organization for easy LLM consumption
- Use clear, unambiguous language throughout
- Continue to serve both human and machine readers effectively
更新后的文件应:
llms.txt- 准确反映当前仓库结构与内容
- 保持符合llms.txt规范
- 为核心文档提供清晰导航
- 移除过时或错误的引用
- 纳入新的重要文件与文档
- 保持逻辑化组织,便于LLM使用
- 全程使用清晰、明确的语言
- 持续有效服务于人类与机器读者