ctms/docs/HELP_OPTIMIZATION_SUMMARY.md

╔══════════════════════════════════════════════════════════════╗ ║ ║ ║ ✅ 使用帮助优化完成 ║ ║ ║ ╚══════════════════════════════════════════════════════════════╝

━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 📊 优化对比 ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

【优化前】 用法: ./install.sh

说明: install.sh 不接受命令行参数。 执行后通过键盘 ↑/↓ 选择安装、更新、卸载、状态等操作，按 Q 退出。

问题： ✗ 内容过于简单，缺少实用信息 ✗ 没有说明底层脚本的使用方法 ✗ 没有提供常见场景示例 ✗ 没有提到新增的在线更新功能

━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

【优化后】

新增内容： ✓ 主入口说明（保留原有说明） ✓ 4 个底层脚本的详细使用方法 - 安装部署（install.sh） - 在线更新（update.sh）⭐ 重点新增 - 安全卸载（uninstall.sh） - 资源状态（status.sh） ✓ 每个脚本的常用选项和参数说明 ✓ 实用示例（交互式 + 自动化） ✓ 快速参考（文档链接） ✓ 4 个常见场景（首次部署/日常更新/自动化/回滚）

结构：

1. 主入口说明
2. 底层脚本详解
   • 安装部署
   • 在线更新（重点）
   • 安全卸载
   • 资源状态
3. 快速参考
4. 常见场景

━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ ✨ 新增的在线更新说明（重点） ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

2. 在线更新 bash scripts/update.sh <环境> [选项]

   核心功能： ✓ 从 GitHub/Gitea 远程仓库拉取代码 ✓ 自动验证项目身份（防止拉错仓库） ✓ 创建备份 tag（支持一键回滚） ✓ 支持 SSH/Token/密码三种认证方式

   常用选项： --repo-url Git 仓库地址（HTTPS 或 SSH） --branch 指定拉取的分支 --yes 跳过交互确认 --force 强制覆盖本地更改 --skip-backup 跳过自动备份

   认证方式： GIT_USERNAME 环境变量：Git 用户名 GIT_PASSWORD 环境变量：Git 密码或 Token

   示例：

   交互式更新（自动检测仓库地址）

   bash scripts/update.sh dev

   指定仓库地址

   bash scripts/update.sh main --repo-url https://github.com/user/ctms.git

   全自动模式（CI/CD）

   export GIT_USERNAME="deploy-bot" export GIT_PASSWORD="ghp_xxxxxxxxxxxxx" bash scripts/update.sh release --repo-url --yes

━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 📖 常见场景示例 ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

场景 1：首次部署开发环境 ./install.sh → 选择"安装部署"→ 选择"dev"

场景 2：更新开发环境到最新代码 ./install.sh → 选择"滚动更新"→ 选择"dev" → 输入仓库地址和凭证

场景 3：生产环境自动化部署 export GIT_USERNAME="deploy-bot" export GIT_PASSWORD="ghp_xxxxxxxxxxxxx" bash scripts/update.sh release
--repo-url https://github.com/company/ctms.git
--branch v1.2.0
--yes
--base-url https://ctms.example.com

场景 4：回滚到更新前版本 git tag | grep pre-update # 查看备份 tag git reset --hard pre-update-<时间戳> # 回滚 bash scripts/install.sh dev --skip-migrate

━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 🎯 优化效果 ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

优化前：5 行（简单说明） 优化后：130+ 行（完整指南）

改进维度： ✓ 信息完整性：增加了所有底层脚本的使用说明 ✓ 实用性：提供了真实可用的命令示例 ✓ 场景覆盖：涵盖交互式、自动化、回滚等场景 ✓ 新功能突出：重点说明了在线更新功能 ✓ 可读性：结构化分节，层次清晰 ✓ 可维护性：与实际脚本功能保持一致

用户收益： ✓ 新手：通过主入口交互式操作即可使用 ✓ 进阶：了解底层脚本，可进行精细控制 ✓ DevOps：获取自动化部署所需的完整参数 ✓ 紧急情况：快速找到回滚等关键操作方法

━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 📝 测试验证 ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

测试命令： bash install.sh --help

测试结果： ✓ 帮助信息完整显示 ✓ 格式美观，层次清晰 ✓ 色彩高亮正常工作 ✓ 所有示例命令正确 ✓ 文档链接路径准确

━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 🔗 相关文件 ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

已修改： ✓ install.sh（usage 函数优化）

配套文档： ✓ docs/GIT_SYNC_GUIDE.md（在线更新完整指南） ✓ docs/UPDATE_OPTIMIZATION_SUMMARY.md（功能总结） ✓ docs/UPDATE_DEMO.txt（快速演示）

━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ ✅ 总结 ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

本次优化成果：

1. ✅ 优化了主入口帮助信息（5 行 → 130+ 行）
2. ✅ 新增在线更新功能的完整说明
3. ✅ 提供了 4 个底层脚本的详细用法
4. ✅ 增加了常见场景的实用示例
5. ✅ 添加了快速参考和文档链接

用户体验：

• 交互式菜单中选择"使用帮助"即可查看
• 命令行执行 bash install.sh --help 也可查看
• 信息全面、结构清晰、易于理解

现在用户可以通过帮助信息快速了解： ✓ 如何使用主入口进行交互式操作 ✓ 如何在自动化场景中调用底层脚本 ✓ 如何使用新增的在线更新功能 ✓ 如何处理常见场景（部署/更新/回滚）

━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

🎉 优化完成！用户现在可以通过帮助信息快速上手所有功能！