文档更新规则

一、目录索引维护规则

1. 索引文件位置

• 索引文件：docs/目录索引.md
• 必须保持在 docs 根目录下

2. 文件变更规则

2.1 新增文件时

1. 在对应分类下添加文件链接
2. 添加简短的文件描述
3. 在更新日志中记录，格式：
   • ➕ 新增 文件名.md

2.2 删除文件时

1. 移除对应的文件链接
2. 在更新日志中记录，格式：
   • ➖ 删除 文件名.md

2.3 修改文件时

1. 如果文件名变更，更新对应链接
2. 在更新日志中记录，格式：
   • 📝 更新 文件名.md

3. 分类规则

3.1 主要分类

• 📚 学习资料：教程和学习文档
• 📝 练习日志：实践记录和解决方案
• 📖 指南文档：指导性文档
• 🖼️ 图片资源：项目相关图片

3.2 分类调整

• 新增分类需要在团队内讨论确认
• 分类图标必须统一规范

4. 更新日志规则

4.1 日期格式

• 使用 YYYY-MM-DD 格式
• 按时间倒序排列

4.2 条目格式

• 使用 emoji + 操作 + 文件名
• emoji 规范：
  • ➕ 新增
  • ➖ 删除
  • 📝 更新
  • 🔄 重命名

5. 链接规则

• 使用相对路径
• 格式：[文件名](./相对路径/文件名.md)
• 必须包含文件扩展名

二、文档命名规则

1. 文件命名

• 使用中文命名
• 避免特殊字符
• 使用有意义的描述性名称

2. 目录命名

• 使用中文命名
• 使用名词性词组
• 表达内容类别

三、自动化建议

1. Git Hooks

• 建议使用 pre-commit 钩子
• 自动检查文档索引更新

2. 脚本工具

• 可以编写自动更新索引的脚本
• 定期运行目录结构检查

四、维护职责

1. 团队成员

• 遵循更新规则
• 及时更新索引

2. 文档管理员

• 定期检查索引完整性
• 维护分类结构
• 规范更新日志

五、检查清单

提交前检查

1. 索引是否更新
2. 链接是否有效
3. 分类是否正确
4. 更新日志是否添加
5. 文件命名是否规范