mirror of https://github.com/SuperClaude-Org/SuperClaude_Framework.git synced 2025-12-17 17:56:46 +00:00

refactor(docs): normalize documentation naming to lowercase for PEP8 compliance (#434 )

* refactor(docs): rename directories to lowercase for PEP8 compliance

- Developer-Guide → developer-guide
- Getting-Started → getting-started
- Reference → reference
- Templates → templates
- User-Guide → user-guide
- User-Guide-jp → user-guide-jp
- User-Guide-kr → user-guide-kr
- User-Guide-zh → user-guide-zh

This change aligns with Python PEP8 package naming conventions.
All 43 files affected.

* refactor: rename root documentation files to lowercase

- CHANGELOG.md → changelog.md
- CODE_OF_CONDUCT.md → code_of_conduct.md
- CONTRIBUTING.md → contributing.md
- SECURITY.md → security.md

Aligns with Python package naming conventions (PEP8).
README files remain uppercase as per convention.

* refactor: move documentation files to docs/ for cleaner root

Moved OSS standard files to docs/:
- CHANGELOG.md → docs/CHANGELOG.md
- CODE_OF_CONDUCT.md → docs/CODE_OF_CONDUCT.md
- CONTRIBUTING.md → docs/CONTRIBUTING.md
- SECURITY.md → docs/SECURITY.md

Root now contains only essential files:
✓ README files (表紙: en, ja, kr, zh)
✓ LICENSE (法的要件)
✓ Build configs (pyproject.toml, setup.py, MANIFEST.in)
✓ VERSION

Rationale:
Cleaner root structure following modern Python project conventions.
All detailed documentation consolidated in docs/ directory.

* refactor: update documentation links after restructure

Auto-updated internal documentation links to reflect new structure:
- docs/ subdirectories now lowercase (PEP8)
- Root files moved to docs/
- All cross-references updated

This commit includes linter-generated link updates.

* chore(docs): keep OSS-standard uppercase root files (CHANGELOG, CODE_OF_CONDUCT, CONTRIBUTING, SECURITY)

* chore(docs): remove duplicated PR docs from repo root (moved under docs)

* docs: rename pm-agent-implementation-status.md -> PM_AGENT.md for clarity

* docs: update links to PM_AGENT.md after rename

---------

Co-authored-by: kazuki <kazuki@kazukinoMacBook-Air.local>

2025-10-15 21:07:39 +05:30

11 KiB

Raw Blame History

SuperClaude 命令指南

SuperClaude 为 Claude Code 提供 21 个命令：用于工作流的 /sc:* 命令和用于专家的 @agent-*。

命令类型

类型	使用位置	格式	示例
斜杠命令	Claude Code	`/sc:[command]`	`/sc:implement "feature"`
智能体	Claude Code	`@agent-[name]`	`@agent-security "review"`
安装命令	终端	`SuperClaude [command]`	`SuperClaude install`

快速测试

# 终端：验证安装
python3 -m SuperClaude --version
# Claude Code CLI 验证：claude --version

# Claude Code：测试命令
/sc:brainstorm "test project"    # 应该询问发现性问题
/sc:analyze README.md           # 应该提供分析

工作流：/sc:brainstorm "idea" → /sc:implement "feature" → /sc:test

🎯 理解 SuperClaude 命令

SuperClaude 如何工作

SuperClaude 提供行为上下文文件，Claude Code 通过读取这些文件来采用专门的行为。当您键入 /sc:implement 时，Claude Code 读取 implement.md 上下文文件并遵循其行为指令。

SuperClaude 命令不是由软件执行的 - 它们是上下文触发器，通过读取框架中的专门指令文件来修改 Claude Code 的行为。

命令类型：

斜杠命令 (/sc:*)：触发工作流模式和行为模式
智能体调用 (@agent-*)：手动激活特定领域专家
标志 (--think、--safe-mode)：修改命令行为和深度

上下文机制：

用户输入：您输入 /sc:implement "auth system"
上下文加载：Claude Code 读取 ~/.claude/superclaude/Commands/implement.md
行为采用：Claude 运用专业知识进行工具选择和验证
增强输出：带有安全考虑和最佳实践的结构化实现

关键要点：这通过上下文管理而不是传统的软件执行来创建复杂的开发工作流。

安装命令 vs 使用命令

🖥️ 终端命令 （实际 CLI 软件）：

SuperClaude install - 安装框架组件
SuperClaude update - 更新现有安装
SuperClaude uninstall - 卸载框架安装
python3 -m SuperClaude --version - 检查安装状态

💬 Claude Code 命令 （上下文触发器）：

/sc:brainstorm - 激活需求发现上下文
/sc:implement - 激活特性开发上下文
@agent-security - 激活安全专家上下文
所有命令仅在 Claude Code 聊天界面中工作

快速开始：尝试 /sc:brainstorm "your project idea" → /sc:implement "feature name" → /sc:test 体验核心工作流。

🧪 Testing Your Setup

🖥️ 终端验证（在终端/CMD 中运行）

# 验证 SuperClaude 是否正常工作（主要方法）
python3 -m SuperClaude --version
# 示例输出：SuperClaude 4.1.5

# Claude Code CLI 版本检查
claude --version

# 检查已安装的组件
python3 -m SuperClaude install --list-components | grep mcp
# 示例输出：显示已安装的 MCP 组件

💬 Claude Code 测试（在 Claude Code 聊天中输入）

# 测试基本 /sc: 命令
/sc:brainstorm "test project"
# 示例行为：开始交互式需求发现

# 测试命令帮助
/sc:help
# 示例行为：显示可用命令列表

如果测试失败：检查安装指南或故障排除

📝 Command Quick Reference

Command Type	Where to Run	Format	Purpose	Example
🖥️ 安装	终端/CMD	`SuperClaude [command]`	设置和维护	`SuperClaude install`
🔧 配置	终端/CMD	`python3 -m SuperClaude [command]`	高级配置	`python3 -m SuperClaude --version`
💬 斜杠命令	Claude Code	`/sc:[command]`	工作流自动化	`/sc:implement "feature"`
🤖 智能体调用	Claude Code	`@agent-[name]`	手动专家激活	`@agent-security "review"`
⚡ 增强标志	Claude Code	`/sc:[command] --flags`	行为修改	`/sc:analyze --think-hard`

记住：所有 /sc: 命令和 @agent- 调用都在 Claude Code 聊天中工作，而不是在您的终端中。它们触发 Claude Code 从 SuperClaude 框架中读取特定的上下文文件。

基本命令

立即提高生产力的核心工作流命令：

`/sc:brainstorm` - 项目发现

目的：交互式需求发现和项目规划语法：/sc:brainstorm "您的想法" [--strategy systematic|creative]

使用案例：

新项目规划：/sc:brainstorm "e-commerce platform"
特性探索：/sc:brainstorm "user authentication system"
问题解决：`/sc:brainstorm "slow database queries"``

`/sc:implement` - 功能开发

目的: 通过智能专家路由进行全栈功能实现
语法: /sc:implement "feature description" [--type frontend|backend|fullstack] [--focus security|performance]

使用场景:

身份验证: /sc:implement "JWT login system"
UI 组件: /sc:implement "responsive dashboard"
APIs: /sc:implement "REST user endpoints"
数据库: /sc:implement "user schema with relationships"

`/sc:analyze` - 代码评估

目的: 跨质量、安全性和性能的综合代码分析
语法: /sc:analyze [path] [--focus quality|security|performance|architecture]

使用场景:

项目健康: /sc:analyze .
安全审计: /sc:analyze --focus security
性能评审: /sc:analyze --focus performance

`/sc:troubleshoot` - 问题诊断

目的: 系统化问题诊断与根本原因分析
语法: /sc:troubleshoot "问题描述" [--type build|runtime|performance]

使用场景:

运行时错误: /sc:troubleshoot "登录时出现500错误"
构建失败: /sc:troubleshoot --type build
性能问题: /sc:troubleshoot "页面加载缓慢"

`/sc:test` - 质量保证

目的: 全面测试与覆盖率分析
语法: /sc:test [--type unit|integration|e2e] [--coverage] [--fix]

使用场景:

完整测试套件: /sc:test --coverage
单元测试: /sc:test --type unit --watch
端到端验证: /sc:test --type e2e

`/sc:improve` - 代码增强

目的: 应用系统化的代码改进和优化
语法: /sc:improve [path] [--type performance|quality|security] [--preview]

使用场景:

常规改进: /sc:improve src/
性能优化: /sc:improve --type performance
安全加固: /sc:improve --type security

`/sc:document` - 文档生成

目的: 为代码和API生成全面的文档
语法: /sc:document [path] [--type api|user-guide|technical] [--format markdown|html]

使用场景:

API文档: /sc:document --type api
用户指南: /sc:document --type user-guide
技术文档: /sc:document --type technical

`/sc:workflow` - 实现规划

目的: 从需求生成结构化的实现计划
语法: /sc:workflow "功能描述" [--strategy agile|waterfall] [--format markdown]

使用场景:

功能规划: /sc:workflow "用户身份验证"
冲刺规划: /sc:workflow --strategy agile
架构规划: /sc:workflow "微服务迁移"

常用工作流

经过验证的命令组合：

新项目设置

/sc:brainstorm "项目概念"              # 定义需求
/sc:design "系统架构"                  # 创建技术设计  
/sc:workflow "实现计划"                # 制定开发路线图

功能开发

/sc:implement "功能名称"               # 构建功能
/sc:test --coverage                   # 通过测试验证
/sc:document --type api               # 生成文档

代码质量改进

/sc:analyze --focus quality           # 评估当前状态
/sc:improve --preview                 # 预览改进
/sc:test --coverage                   # 验证变更

Bug调查

/sc:troubleshoot "问题描述"            # 诊断问题
/sc:analyze --focus problem-area      # 深度分析
/sc:improve --fix --safe-mode         # 应用针对性修复

完整命令参考

开发命令

命令	目的	最适用于
workflow	实现规划	项目路线图，冲刺规划
implement	功能开发	全栈功能，API开发
build	项目编译	CI/CD，生产构建
design	系统架构	API规范，数据库模式

分析命令

命令	目的	最适用于
analyze	代码评估	质量审计，安全评审
troubleshoot	问题诊断	Bug调查，性能问题
explain	代码解释	学习，代码评审

质量命令

命令	目的	最适用于
improve	代码增强	性能优化，重构
cleanup	技术债务	清理无用代码，组织整理
test	质量保证	测试自动化，覆盖率分析
document	文档生成	API文档，用户指南

项目管理

命令	目的	最适用于
estimate	项目估算	时间线规划，资源分配
task	任务管理	复杂工作流，任务跟踪
spawn	元编排	大型项目，并行执行

实用工具命令

命令	目的	最适用于
git	版本控制	提交管理，分支策略
index	命令发现	探索功能，查找命令

会话命令

命令	目的	最适用于
load	上下文加载	会话初始化，项目启用
save	会话持久化	检查点，上下文保存
reflect	任务验证	进度评估，完成验证
select-tool	工具优化	性能优化，工具选择

命令索引

按功能分类：

规划: brainstorm, design, workflow, estimate
开发: implement, build, git
分析: analyze, troubleshoot, explain
质量: improve, cleanup, test, document
管理: task, spawn, load, save, reflect
工具: index, select-tool

按复杂度分类：

初学者: brainstorm, implement, analyze, test
中级: workflow, design, improve, document
高级: spawn, task, select-tool, reflect

故障排除

命令问题：

命令未找到: 验证安装: python3 -m SuperClaude --version
无响应: 重启 Claude Code 会话
处理延迟: 使用 --no-mcp 测试不使用 MCP 服务器

快速修复：

重置会话: /sc:load 重新初始化
检查状态: SuperClaude install --list-components
获取帮助: 故障排除指南

下一步

标志指南 - 控制命令行为
智能体指南 - 专家激活
示例手册 - 真实使用模式

11 KiB Raw Blame History Unescape Escape

SuperClaude 命令指南

命令类型

快速测试

🎯 理解 SuperClaude 命令

SuperClaude 如何工作

命令类型：

上下文机制：

安装命令 vs 使用命令

🧪 Testing Your Setup

🖥️ 终端验证（在终端/CMD 中运行）

💬 Claude Code 测试（在 Claude Code 聊天中输入）

📝 Command Quick Reference

目录

基本命令

/sc:brainstorm - 项目发现

/sc:implement - 功能开发

/sc:analyze - 代码评估

/sc:troubleshoot - 问题诊断

/sc:test - 质量保证

/sc:improve - 代码增强

/sc:document - 文档生成

/sc:workflow - 实现规划

常用工作流

新项目设置

功能开发

代码质量改进

Bug调查

完整命令参考

开发命令

分析命令

质量命令

项目管理

实用工具命令

会话命令

命令索引

故障排除

下一步

11 KiB

Raw Blame History

`/sc:brainstorm` - 项目发现

`/sc:implement` - 功能开发

`/sc:analyze` - 代码评估

`/sc:troubleshoot` - 问题诊断

`/sc:test` - 质量保证

`/sc:improve` - 代码增强

`/sc:document` - 文档生成

`/sc:workflow` - 实现规划