Skip to content

Commit e8ce17d

Browse files
Test Userclaude
andcommitted
docs(*): 用户文档全面优化——安装路径修正 + 双语完善 + 信息架构改进
- README: 前置条件明示 + 源码安装为主 + plugin install 降级为备选 - README: 动态版本 badge + 语言切换首行 + 重复标题修正 - README: 新增"What devpace is NOT"段 + 问题排查链接 + 中文文档标注 - CHANGELOG: 双语头部 + 英文版本摘要导航表 - Walkthrough: 新增前置条件段 + 具体路径示例 - CONTRIBUTING: git clone 占位符替换为实际 URL - marketplace.json: description 去除 BizDevOps 术语,与 plugin.json 对齐 - CODE_OF_CONDUCT: 执行联系从公开 Issues 改为私密渠道 - Bug Report 模板: 新增 Claude 输出段 - GitHub Discussions 已启用 Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
1 parent 0dd41c0 commit e8ce17d

File tree

9 files changed

+94
-38
lines changed

9 files changed

+94
-38
lines changed

.claude-plugin/marketplace.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "devpace",
3-
"description": "BizDevOps development pace manager for Claude Code — structured workflow from business goals to code changes with cross-session continuity, quality gates, and change management",
3+
"description": "AI-native development pace manager for Claude Code — change impact analysis, quality gates, goal-to-code traceability, and cross-session continuity",
44
"owner": {
55
"name": "paceforge"
66
},

.github/ISSUE_TEMPLATE/bug_report.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,14 @@ labels: bug
2323

2424
<!-- What actually happened / 实际发生了什么 -->
2525

26+
## Claude Output / Claude 输出
27+
28+
<!-- Paste the relevant Claude output or error message / 粘贴相关的 Claude 输出或错误信息 -->
29+
30+
```
31+
(paste here)
32+
```
33+
2634
## Environment / 环境信息
2735

2836
- OS:

CHANGELOG.md

Lines changed: 22 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,27 @@
11
# Changelog
22

3-
本文件记录 devpace 的所有重要变更。
4-
5-
格式基于 [Keep a Changelog](https://keepachangelog.com/en/1.1.0/)
3+
All notable changes to devpace are documented here. For English release summaries, see [GitHub Releases](https://github.com/arch-team/devpace/releases).
4+
5+
本文件记录 devpace 的所有重要变更。格式基于 [Keep a Changelog](https://keepachangelog.com/en/1.1.0/)
6+
7+
## Version Overview
8+
9+
| Version | Date | Highlights |
10+
|---------|------|-----------|
11+
| [1.4.0](#140---2026-02-25) | 2026-02-25 | Risk Fabric — pre-flight risk scan + runtime monitoring + graduated response |
12+
| [1.3.0](#130---2026-02-24) | 2026-02-24 | DORA proxy metrics + cross-project insights + CI/CD auto-detection |
13+
| [1.2.0](#120---2026-02-24) | 2026-02-24 | Test management (/pace-test) + global navigation (/pace-next) |
14+
| [1.1.0](#110---2026-02-22) | 2026-02-22 | Release orchestration — changelog, version bump, git tag, GitHub Release |
15+
| [1.0.0](#100---2026-02-22) | 2026-02-22 | Stable release — 26 scenarios, 48 features, 148 static tests |
16+
| [0.9.1](#091---2026-02-22) | 2026-02-22 | Skill description CSO audit + migration path fix |
17+
| [0.9.0](#090---2026-02-22) | 2026-02-22 | BMAD-METHOD deep study — adversarial review, complexity-adaptive paths |
18+
| [0.8.0](#080---2026-02-22) | 2026-02-22 | ECC deep study — cross-platform hooks, smart checks, model tiering |
19+
| [0.7.0](#070---2026-02-22) | 2026-02-22 | Open-source ecology study — state machine, execution quality, review quality |
20+
| [0.6.0](#060---2026-02-22) | 2026-02-22 | Linear AI study — source tracing, progressive autonomy, correction-as-learning |
21+
| [0.5.0](#050---2026-02-21) | 2026-02-21 | Progressive teaching, value visibility, friction reduction |
22+
| [0.4.0](#040---2026-02-21) | 2026-02-21 | UX optimization — gradual init, advance mode opt-in, throttling |
23+
| [0.3.0](#030---2026-02-21) | 2026-02-21 | Full BizDevOps lifecycle — release, feedback, roles, DORA metrics |
24+
| [0.1.0](#010---2026-02-20) | 2026-02-20 | Initial public release |
625

726
## [Unreleased]
827

CODE_OF_CONDUCT.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -61,8 +61,9 @@ representative at an online or offline event.
6161
## Enforcement
6262

6363
Instances of abusive, harassing, or otherwise unacceptable behavior may be
64-
reported to the community leaders responsible for enforcement at
65-
**GitHub Issues at https://github.com/arch-team/devpace/issues**.
64+
reported to the community leaders responsible for enforcement via
65+
[GitHub Private Vulnerability Reporting](https://github.com/arch-team/devpace/security/advisories/new)
66+
or by emailing **devpace-conduct@proton.me**.
6667

6768
All complaints will be reviewed and investigated promptly and fairly.
6869

CONTRIBUTING.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ Thank you for your interest in contributing to devpace! This guide covers everyt
3838

3939
```bash
4040
# Clone the repository
41-
git clone <repo-url>
41+
git clone https://github.com/arch-team/devpace.git
4242
cd devpace
4343

4444
# Install test dependencies

CONTRIBUTING_zh.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@
3838

3939
```bash
4040
# 克隆仓库
41-
git clone <repo-url>
41+
git clone https://github.com/arch-team/devpace.git
4242
cd devpace
4343

4444
# 安装测试依赖

README.md

Lines changed: 29 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
1+
🌐 [中文版](README_zh.md) | English
2+
13
# devpace
24

35
Give your Claude Code projects a steady development pace — requirements change, rhythm stays.
46

5-
![version](https://img.shields.io/badge/version-1.4.0-blue) ![license](https://img.shields.io/badge/license-MIT-green) ![type](https://img.shields.io/badge/Claude%20Code-Plugin-purple)
6-
7-
🌐 [中文版](README_zh.md) | English
7+
![version](https://img.shields.io/github/v/release/arch-team/devpace?label=version) ![license](https://img.shields.io/badge/license-MIT-green) ![type](https://img.shields.io/badge/Claude%20Code-Plugin-purple)
88

99
## Why devpace
1010

@@ -17,7 +17,7 @@ When using Claude Code for product development:
1717
| Work drifts from goals | Technical work disconnects from business goals, lots done but unclear value | Goal-to-code traceability at all times |
1818
| Re-explain everything each session | Manual approach needs **8** user corrections (3 interruption test) | Auto-restores context, **0** corrections |
1919

20-
[See full walkthrough: from init to done](examples/todo-app-walkthrough.md)
20+
> [See full walkthrough: from init to done](examples/todo-app-walkthrough.md)
2121
2222
## 30-Second Experience
2323

@@ -43,22 +43,27 @@ All state is stored in `.devpace/` folder at project root, pure Markdown, human-
4343

4444
## Installation
4545

46-
### Quick Install
46+
> **Prerequisite**: [Claude Code CLI](https://claude.ai/code) must be installed.
47+
48+
### From Source (Recommended)
4749

4850
```bash
49-
/plugin install devpace
51+
git clone https://github.com/arch-team/devpace.git
52+
claude --plugin-dir /path/to/devpace
5053
```
5154

52-
### Verify Installation
53-
54-
Run `/pace-theory` in Claude Code to confirm the plugin is loaded.
55-
56-
### Manual Install
55+
### Plugin Registry
5756

5857
```bash
59-
claude --plugin-dir /path/to/devpace
58+
/plugin install devpace
6059
```
6160

61+
> If `/plugin install` is not available yet, use the "From Source" method above.
62+
63+
### Verify Installation
64+
65+
After installing, type `/pace-` in Claude Code. If devpace is loaded, you'll see auto-complete suggestions for `/pace-init`, `/pace-dev`, `/pace-status`, etc.
66+
6267
## Commands
6368

6469
### Daily Use
@@ -122,7 +127,7 @@ Most of the time you don't need commands — saying "help me implement X" equals
122127
| Risk fabric | Pre-flight 5-dimension risk scan + Runtime monitoring + Graduated autonomous response (High requires human confirmation) |
123128
| Cross-project insights | High-confidence insights exportable/importable to other projects, reducing redundant learning |
124129

125-
## How It Works
130+
## Workflow
126131

127132
### Two Modes
128133

@@ -151,13 +156,19 @@ Pause anytime, resume from where you left off
151156
| Byproducts not prerequisites | Structured data is auto-produced from work, not a required input |
152157
| Interruption tolerance | Interrupt at any point, seamless resume next time |
153158

159+
## What devpace is NOT
160+
161+
- **Not a CI/CD pipeline** — it works alongside your existing tools (GitHub Actions, Jenkins, etc.)
162+
- **Not a project management platform** — no web dashboard, no team features, pure CLI
163+
- **Not a replacement for git** — it creates Markdown state files in `.devpace/`, your code stays in git
164+
154165
## Learn More
155166

156-
- [User Guide](docs/user-guide.md) — Full command reference, modes, state machine details
157-
- [Walkthrough](examples/todo-app-walkthrough.md) — Complete example from init to finish
158-
- [Contributing (English)](CONTRIBUTING.md) — Dev environment, testing, PR process
159-
- [Contributing (中文)](CONTRIBUTING_zh.md)开发环境、测试、PR 规范
160-
- [Changelog](CHANGELOG.md)Version history
167+
- [User Guide](docs/user-guide.md) (Chinese) — Full command reference, modes, state machine details
168+
- [Walkthrough](examples/todo-app-walkthrough.md) (Chinese) — Complete example from init to finish
169+
- [Contributing](CONTRIBUTING.md) — Dev environment, testing, PR process
170+
- [Changelog](CHANGELOG.md)Version history ([English summaries on GitHub Releases](https://github.com/arch-team/devpace/releases))
171+
- [Troubleshooting](https://github.com/arch-team/devpace/issues?q=label%3Abug)Search known issues or open a new one
161172

162173
---
163174
MIT

README_zh.md

Lines changed: 23 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55
给 Claude Code 项目一个稳定的研发节奏——需求在变,节奏不乱。
66

7-
![version](https://img.shields.io/badge/version-1.4.0-blue) ![license](https://img.shields.io/badge/license-MIT-green) ![type](https://img.shields.io/badge/Claude%20Code-Plugin-purple)
7+
![version](https://img.shields.io/github/v/release/arch-team/devpace?label=version) ![license](https://img.shields.io/badge/license-MIT-green) ![type](https://img.shields.io/badge/Claude%20Code-Plugin-purple)
88

99
## 为什么需要 devpace
1010

@@ -43,22 +43,27 @@ devpace 是一个 Claude Code Plugin,通过三种机制扩展 Claude 的能力
4343

4444
## 安装
4545

46-
### 快速安装
46+
> **前置条件**:需先安装 [Claude Code CLI](https://claude.ai/code)
47+
48+
### 从源码安装(推荐)
4749

4850
```bash
49-
/plugin install devpace
51+
git clone https://github.com/arch-team/devpace.git
52+
claude --plugin-dir /path/to/devpace
5053
```
5154

52-
### 验证安装
53-
54-
安装后在 Claude Code 中运行 `/pace-theory`,确认插件已加载。
55-
56-
### 手动安装
55+
### 插件注册表
5756

5857
```bash
59-
claude --plugin-dir /path/to/devpace
58+
/plugin install devpace
6059
```
6160

61+
> 如果 `/plugin install` 尚不可用,请使用上方"从源码安装"方式。
62+
63+
### 验证安装
64+
65+
安装后在 Claude Code 中输入 `/pace-`,如果 devpace 加载成功,会看到 `/pace-init``/pace-dev``/pace-status` 等自动补全建议。
66+
6267
## 命令
6368

6469
### 日常使用
@@ -122,7 +127,7 @@ claude --plugin-dir /path/to/devpace
122127
| <nobr>风险织网</nobr> | Pre-flight 5 维风险扫描 + Runtime 实时监控 + 分级自主响应(High 必须人类确认) |
123128
| <nobr>跨项目经验</nobr> | 高置信度经验可导出/导入到其他项目,减少重复学习 |
124129

125-
## 工作方式
130+
## 工作流程
126131

127132
### 两种模式
128133

@@ -151,12 +156,19 @@ claude --plugin-dir /path/to/devpace
151156
| <nobr>副产物非前置</nobr> | 结构化数据是工作的自动产出,不是前置要求 |
152157
| <nobr>中断容错</nobr> | 任意时刻中断,下次无缝恢复 |
153158

159+
## devpace 不是什么
160+
161+
- **不是 CI/CD 流水线** —— 它与你现有的工具(GitHub Actions、Jenkins 等)并行工作
162+
- **不是项目管理平台** —— 没有 Web 界面、没有团队功能,纯 CLI
163+
- **不是 git 的替代品** —— 它在 `.devpace/` 中创建 Markdown 状态文件,你的代码仍在 git 中管理
164+
154165
## 了解更多
155166

156167
- [用户指南](docs/user-guide.md) — 完整命令参考、工作模式、状态机细节
157168
- [端到端演示](examples/todo-app-walkthrough.md) — 从初始化到完成的完整示例
158169
- [贡献指南](CONTRIBUTING_zh.md) — 开发环境、测试、PR 规范
159-
- [更新日志](CHANGELOG.md) — 版本历史
170+
- [更新日志](CHANGELOG.md) — 版本历史([英文摘要见 GitHub Releases](https://github.com/arch-team/devpace/releases)
171+
- [问题排查](https://github.com/arch-team/devpace/issues?q=label%3Abug) — 搜索已知问题或提交新 Issue
160172

161173
---
162174
MIT

examples/todo-app-walkthrough.md

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,12 +2,17 @@
22

33
本演示展示 devpace 管理一个完整的开发周期——从项目初始化到任务合并,包括一次中途需求变更。
44

5+
## 前置条件 / Prerequisites
6+
7+
- 已安装 [Claude Code CLI](https://claude.ai/code)
8+
- 已获取 devpace:`git clone https://github.com/arch-team/devpace.git`
9+
510
## 准备
611

712
```bash
813
# 在你的项目目录中加载 devpace 插件
914
cd ~/projects/my-todo-app
10-
claude --plugin-dir /path/to/devpace
15+
claude --plugin-dir ~/devpace # 替换为你克隆 devpace 的实际路径
1116
```
1217

1318
## 阶段 1:初始化

0 commit comments

Comments
 (0)