istarwyh

Update Full Docs

Name: Update Full Docs
Author: istarwyh

Development community

SOURCE https://github.com/istarwyh/mcpadvisor/blob/main/.claude/commands/update-full-docs.md

Description

# 文档更新命令在每次commit或PR前，使用此命令确保所有相关文档都已正确更新。 ## 使用方法 ``` /update-docs [changes-description] ``` ## 执行步骤 ### 1. 分析代码变更首先分析当前的代码变更，确定影响范围： ```bash # 查看当前变更 git status git diff --cached # 查看已暂存的变更 git diff HEAD # 查看所有变更 ``` ### 2. 识别需要更新的文档类型根据变更类型，确定需要更新的文档： #### 🆕 新功能 (feat) - [ ] `docs/GETTING_STARTED.md` - 添加使用说明和配置选项 - [ ] `docs/TECHNICAL_REFERENCE.md` - 添加技术实现细节 - [ ] `README.md` / `README_zh.md` - 更新功能列表和示例 - [ ] `docs/ARCHITECTURE.md` - 更新架构图和组件说明（如有结构变更） #### 🐛 Bug修复 (fix

Installation

Installs to ~/.claude/commands/istarwyh-mcpadvisor-update-full-docs.md

Terminal

mkdir -p ~/.claude/commands && curl -fsSL https://raw.githubusercontent.com/istarwyh/mcpadvisor/HEAD/.claude/commands/update-full-docs.md -o ~/.claude/commands/istarwyh-mcpadvisor-update-full-docs.md

Restart Claude Code, or start a new session, for it to be picked up.