Back to Details

sync-docs

Compare original and translation side by side

🇺🇸

Original

English
🇨🇳

Translation

Chinese
Update and maintain project documentation for CLAUDE.md and README.md:
更新并维护CLAUDE.md和README.md项目文档：

1. CLAUDE.md Management

1. CLAUDE.md 管理

Purpose: Keep Claude's project instructions current and accurate
  • Scan project structure: Check for new tools, scripts, build systems
  • Update build commands: Sync with package.json, Makefile, or build configs
  • Add new patterns: Document coding conventions, file organization
  • Refresh tool commands: Update linting, testing, deployment instructions
  • Check environment setup: Verify installation and setup steps
目的： 保持Claude的项目说明内容最新且准确
  • 扫描项目结构： 检查新增工具、脚本、构建系统
  • 更新构建命令： 与package.json、Makefile或构建配置保持同步
  • 添加新规范： 记录编码约定、文件组织结构
  • 更新工具命令： 刷新代码检查、测试、部署相关说明
  • 检查环境设置： 验证安装和配置步骤

2. README.md Maintenance

2. README.md 维护

Purpose: Keep public project documentation up-to-date
  • Update installation: Check dependencies, requirements, setup steps
  • Refresh usage examples: Verify code samples and API documentation
  • Validate links: Test external links, badges, and references
  • Update project status: Current features, roadmap, version info
  • Check screenshots/demos: Ensure visual examples are current
目的： 保持公开项目文档内容最新
  • 更新安装说明： 检查依赖项、要求和设置步骤
  • 刷新使用示例： 验证代码示例和API文档
  • 验证链接： 测试外部链接、徽章和参考资料
  • 更新项目状态： 当前功能、路线图、版本信息
  • 检查截图/演示： 确保视觉示例内容最新

3. Smart Detection Process

3. 智能检测流程

  1. File existence: Create CLAUDE.md or README.md if missing
  2. Project analysis: Scan codebase for changes since last update
  3. Cross-reference: Compare project structure with documented instructions
  4. Outdated sections: Identify stale information automatically
  5. Consistency check: Ensure both files complement each other
  1. 文件存在性检查： 若CLAUDE.md或README.md缺失则创建
  2. 项目分析： 扫描代码库，识别自上次更新以来的变更
  3. 交叉引用： 对比项目结构与文档中的说明
  4. 过时内容识别： 自动检测陈旧信息
  5. 一致性检查： 确保两个文档内容互补

4. Validation Steps

4. 验证步骤

  • Run project commands mentioned in docs to verify they work
  • Test installation steps from scratch perspective
  • Validate all external links and references
  • Check that CLAUDE.md instructions match current project setup
  • Ensure README.md accurately represents current project state
Focus on keeping both files synchronized with the actual project state and useful for their respective audiences: Claude for CLAUDE.md, users/developers for README.md.
  • 运行文档中提及的项目命令，验证其可用性
  • 从全新环境视角测试安装步骤
  • 验证所有外部链接和参考资料
  • 检查CLAUDE.md中的说明是否与当前项目设置匹配
  • 确保README.md准确反映项目当前状态
重点在于保持两个文档与项目实际状态同步，并为各自受众提供有用信息：CLAUDE.md面向Claude，README.md面向用户/开发者。