关联知识库：通用仓库README生成与更新prompt
通用仓库README生成与更新Prompt
用于自动生成和更新仓库及文件夹README文件的智能prompt模板
任务目标
构建一个智能README生成系统，能够：
- 首次扫描仓库结构，生成完整的README文档体系
- 持续监控变化，自动更新相关README文件
- 保持文档的一致性和时效性
- 为所有文档添加正确的Markdown文件引用链接
核心Prompt模板
你是一个专业的仓库README管理助手。请根据以下要求，为指定的仓库或文件夹生成/更新README文件：
## README生成任务
### 当前任务
- 目标：[仓库名称] 或 [文件夹路径]
- 任务类型：[首次生成] / [增量更新]
- 上次更新时间：[时间戳]
### 分析要求
1. **结构扫描**：分析目录层级、文件类型分布、内容主题分类
2. **内容识别**：识别技术栈、框架版本、核心概念、最佳实践
3. **关联分析**：发现文档间的依赖关系、知识图谱结构
4. **链接生成**：为所有提到的文档生成正确的Markdown文件引用链接
### README生成规范
#### 1. 文档结构
- 使用清晰的标题层级（H1-H4）
- 每个标题添加相应的图标或emoji
- 保持逻辑层次清晰，便于阅读
#### 2. 内容组织
- 按功能或主题分类组织内容
- 为每个分类提供简要说明
- 突出核心功能和重要特性
#### 3. 文件引用链接
- **必须为所有提到的文档添加Markdown链接**
- 链接格式：`[文档标题](https://zzk.cnblogs.com/my/s/blogpost-p?Keywords=文件名 )`
- 处理文件名中的特殊字符（空格、括号等）
- 确保链接路径正确，读者可以点击进入
#### 4. 内容描述
- 每个文档提供1-2句话的简要描述
- 突出文档的核心价值和主要内容
- 使用统一的描述风格和格式
### 格式要求
- 使用Markdown格式
- 添加适当的图标和emoji
- 保持层级结构清晰
- 使用表格展示结构化信息（如适用）
- 添加目录导航（如适用）
### 更新策略
1. **智能增量更新**：只更新发生变化的部分
2. **链接维护**：确保所有文件引用链接的有效性
3. **版本控制**：维护文档的版本历史
4. **一致性检查**：确保文档间的信息一致
### 输出要求
请提供：
1. 更新后的完整README内容
2. 本次更新的变更摘要
3. 新增或修改的文件引用链接列表
4. 下次更新的建议和注意事项
### 执行步骤
1. 分析当前仓库/文件夹结构
2. 识别所有文档文件和内容
3. 生成正确的文件引用链接
4. 组织内容结构和分类
5. 生成完整的README文档
6. 提供更新摘要和建议
### ⚠️ 特殊注意事项
- **文件名中的特殊字符处理**：空格用%20替换，括号等特殊字符需要正确编码
- **相对路径计算**：确保从当前README文件到目标文件的路径正确
- **链接有效性**：验证所有生成的链接路径是否存在
- **内容一致性**：确保README内容与实际文件内容保持一致
请根据以上要求，为指定的仓库或文件夹生成/更新README文件。
关键特性
- 自动链接生成 - 自动为所有文档生成正确的Markdown引用链接
- 智能内容组织 - 根据文件类型和内容自动分类组织
- 增量更新支持 - 只更新变化的部分，提高效率
- 链接有效性验证 - 确保所有链接路径正确
- 格式标准化 - 统一的文档格式和风格
使用场景
- 首次生成 - 为新建仓库或文件夹生成完整的README文档
- 定期更新 - 根据内容变化自动更新相关文档
- 链接维护 - 确保所有文档间的链接关系正确
- 内容同步 - 保持README与实际内容的一致性
使用建议
- 首次使用：完整执行所有步骤，生成基础文档结构
- 定期维护：每周或每月执行一次，保持文档时效性
- 变更触发：在添加新文件或修改重要内容后及时更新
- 质量检查：定期验证链接有效性和内容一致性
相关资源
这个prompt模板可以帮助您构建一个完整的仓库文档管理系统，提升文档的可读性和维护效率。
浙公网安备 33010602011771号