Skip to content

Commit 25a2c9f

Browse files
committed
docs: rewrite README first-screen narrative for user-facing clarity
- Hero: result-oriented tagline (resumable, traceable, decisions stay with project) - What You'll Notice: rebalanced 5 pillars (relay + review + constraint + knowledge + simplicity) - What Your Host Doesn't Solve: 4-row comparison table (portable state, isolated review, re-confirmation, reusable assets) - Quick Start: split into 'already enabled' (Convention) and 'first time' (install) paths - Cross-review: downgraded from 'second model' to 'isolated independent review' per actual skill capability - Removed protocol jargon from first screen (machine-readable protocols → project-level conventions) - Moved 'What You Get After Install' from pre-install to post-install position, rewritten as workflow changes - Host availability matrix: explicit Convention/Runtime distinction - CN/EN fully aligned Context-Checkpoint: B Release-Sync: yes Release-Version: 2026-05-06.181908 Release-Date: 2026-05-06
1 parent c086af0 commit 25a2c9f

7 files changed

Lines changed: 83 additions & 60 deletions

File tree

CHANGELOG.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,21 @@ Format: Summary → Plan Packages → File Details (collapsible).
66

77
## [Unreleased]
88

9+
## [2026-05-06.181908] - 2026-05-06
10+
11+
### Summary
12+
13+
- Changes across: Docs.
14+
15+
<details>
16+
<summary>File details</summary>
17+
18+
**Docs** — Refined public documentation:
19+
- `README.md`
20+
- `README.zh-CN.md`
21+
22+
</details>
23+
924
## [2026-05-06.143421] - 2026-05-06
1025

1126
### Summary

Claude/Skills/CN/CLAUDE.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
<!-- bootstrap: lang=zh-CN; encoding=UTF-8 -->
2-
<!-- SOPIFY_VERSION: 2026-05-06.143421 -->
2+
<!-- SOPIFY_VERSION: 2026-05-06.181908 -->
33
<!-- ARCHITECTURE: Adaptive Workflow + Layered Rules -->
44

55
# Sopify - 自适应 AI 编程助手

Claude/Skills/EN/CLAUDE.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
<!-- bootstrap: lang=en-US; encoding=UTF-8 -->
2-
<!-- SOPIFY_VERSION: 2026-05-06.143421 -->
2+
<!-- SOPIFY_VERSION: 2026-05-06.181908 -->
33
<!-- ARCHITECTURE: Adaptive Workflow + Layered Rules -->
44

55
# Sopify - Adaptive AI Programming Assistant

Codex/Skills/CN/AGENTS.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
<!-- bootstrap: lang=zh-CN; encoding=UTF-8 -->
2-
<!-- SOPIFY_VERSION: 2026-05-06.143421 -->
2+
<!-- SOPIFY_VERSION: 2026-05-06.181908 -->
33
<!-- ARCHITECTURE: Adaptive Workflow + Layered Rules -->
44

55
# Sopify - 自适应 AI 编程助手

Codex/Skills/EN/AGENTS.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
<!-- bootstrap: lang=en-US; encoding=UTF-8 -->
2-
<!-- SOPIFY_VERSION: 2026-05-06.143421 -->
2+
<!-- SOPIFY_VERSION: 2026-05-06.181908 -->
33
<!-- ARCHITECTURE: Adaptive Workflow + Layered Rules -->
44

55
# Sopify - Adaptive AI Programming Assistant

README.md

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

55
<img src="./assets/logo.svg" width="120" alt="Sopify Logo" />
66

7-
**A recoverable, reviewable, cross-session AI coding workflow**
7+
**Resumable, traceable AI coding — decisions and history stay with the project**
88

99
[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](./LICENSE)
1010
[![Docs](https://img.shields.io/badge/docs-CC%20BY%204.0-green.svg)](./LICENSE-docs)
11-
[![Version](https://img.shields.io/badge/version-2026--05--06.143421-orange.svg)](#version-history)
11+
[![Version](https://img.shields.io/badge/version-2026--05--06.181908-orange.svg)](#version-history)
1212
[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)](./CONTRIBUTING.md)
1313

1414
English · [简体中文](./README.zh-CN.md) · [Quick Start](#quick-start) · [Configuration](#configuration) · [Contributors](./CONTRIBUTORS.md)
@@ -21,32 +21,41 @@ English · [简体中文](./README.zh-CN.md) · [Quick Start](#quick-start) · [
2121

2222
As repositories grow, AI-assisted development runs into a hidden problem: decision context stays trapped in chat history, each new session re-derives the project state, and the user's mental model, the AI's understanding, and the codebase start to drift apart.
2323

24-
Sopify uses machine-readable protocols to make critical steps visible: when facts are missing, it stops and asks for them; when a branch needs a decision, it waits for confirmation; when work is interrupted, it resumes from current state instead of improvising. The basic process record is generated automatically, but the long-term compounding value still depends on consistently closing out work and maintaining project knowledge.
24+
Sopify uses project-level conventions to make critical steps visible: when facts are missing, it stops and asks for them; when a branch needs a decision, it waits for confirmation; when work is interrupted, it resumes from current state instead of improvising. The basic process record is generated automatically, but the long-term compounding value still depends on consistently closing out work and maintaining project knowledge.
2525

2626
### What You'll Actually Notice
2727

28-
- The AI does not silently make key decisions; it pauses when facts are missing or a path needs your confirmation.
29-
- After an interruption, work resumes from the last stopping point instead of starting over.
30-
- Plans, history, and blueprint become reusable project assets instead of disposable chat logs.
31-
- Simple changes are not slowed down by the full process; complex work adds the necessary structure when needed.
28+
- After an interruption, work resumes from the last stopping point — even when you switch to a different AI host or model.
29+
- Complex changes can be independently reviewed in an isolated pass before execution.
30+
- When a plan changes after execution was authorized, the AI cannot silently proceed — it re-confirms with you first.
31+
- Plans, decisions, and review outcomes accumulate as reusable project assets, not disposable chat history.
32+
- The AI pauses when facts are missing or a path needs your confirmation; simple tasks stay lightweight.
3233

3334
### What Kinds of Projects Benefit Most
3435

3536
- Multi-stage work that keeps moving in the same repository instead of one-off edits
3637
- You're willing to manage progress with plan / blueprint artifacts and close out each stage
3738

38-
## What You Get After Install
39+
### What Your AI Host Doesn't Solve
3940

40-
- Your host is ready to run Sopify after install.
41-
- The first time you trigger Sopify in a project, it prepares the local `.sopify-runtime/`.
42-
- `status` shows the current host / workspace state.
43-
- `doctor` shows deeper installation and runtime diagnostics and repair guidance.
44-
45-
This guide focuses on install visibility, verification, and stable first use; repository cleanup flows are intentionally out of scope here.
41+
| Gap | Sopify's answer |
42+
|-----|-----------------|
43+
| State is trapped in a single host's chat session | Portable project state — switch hosts mid-task |
44+
| No independent quality gate | An isolated, independent review pass before execution |
45+
| Decisions are invisible and non-auditable | Plan changes force re-confirmation — the AI cannot silently proceed |
46+
| Each session's learning is disposable | Plans, decisions, and reviews persist as reusable project assets |
4647

4748
## Quick Start
4849

49-
### Installation
50+
Two ways to start, depending on your repo:
51+
52+
### Already using Sopify? Try it directly
53+
54+
If your repo has `.sopify-skills/`, open any AI host (Claude, Cursor, Codex…) and ask it to continue an unfinished task — it picks up from the last stopping point, not from scratch. That's the protocol working, no runtime needed.
55+
56+
Full Convention walkthrough: [protocol.md §4](./.sopify-skills/blueprint/protocol.md#4-典型生命周期样例)
57+
58+
### First time? Install first
5059

5160
```bash
5261
# Recommended: official stable one-liner
@@ -80,7 +89,7 @@ Install targets:
8089
- `claude:zh-CN`
8190
- `claude:en-US`
8291

83-
Host availability matrix:
92+
The protocol (Convention mode) works with any host. Verified runtime integrations today:
8493

8594
| Host | Install target | Availability | Validation coverage | Notes |
8695
|------|----------------|--------------|---------------------|-------|
@@ -99,6 +108,13 @@ Installer behavior:
99108
- Sopify prepares `.sopify-runtime/` the first time you trigger it in a project workspace
100109
- `--workspace` is an advanced prewarm path for maintainers, CI, or explicit repository setup
101110

111+
### How Your Workflow Changes After Install
112+
113+
- Use `~go` when you want Sopify to manage the full task workflow for you.
114+
- Interrupt anytime — come back (even in a different tool) and resume from where you left off.
115+
- Complex changes can get an independent review before execution starts.
116+
- Run `status` to see current progress, `doctor` to troubleshoot.
117+
102118
### Verify Your Install
103119

104120
```bash
@@ -110,18 +126,6 @@ python3 scripts/sopify_doctor.py --format text
110126
- `workspace outcome: stub_selected [continue]`: the workspace runtime entry is healthy
111127
- Payload or bundle corruption errors (for example `global_bundle_missing`, `global_bundle_incompatible`, or `global_index_corrupted`): repair the install and retry
112128

113-
### Convention Mode (No Runtime)
114-
115-
If you only need the project protocol without installing the runtime, you can work in Convention mode directly:
116-
117-
1. **Read** `.sopify-skills/blueprint/` to understand the project context
118-
2. **Write** a plan in `.sopify-skills/plan/YYYYMMDD_feature/plan.md` (must include title / scope / approach + inline tasks)
119-
3. **Archive** to `.sopify-skills/history/YYYY-MM/` and generate `receipt.md`
120-
121-
See [protocol.md §4 — Lifecycle Examples](./.sopify-skills/blueprint/protocol.md#4-典型生命周期样例) for the full Convention flow (Example A), and [protocol.md §5 — Compliance Checklist](./.sopify-skills/blueprint/protocol.md#5-协议合规检查清单) for self-check items.
122-
123-
Any host that follows these three steps is Convention-compliant — no runtime, no installer, no CLI required.
124-
125129
### Choose an Entry by Task Size
126130

127131
| Task Type | Sopify Path |

README.zh-CN.md

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

55
<img src="./assets/logo.svg" width="120" alt="Sopify Logo" />
66

7-
**可恢复、可复盘、可沉淀的 AI 编程工作流**
7+
**可恢复、可追溯的 AI 编程 — 决策和历史跟着项目走**
88

99
[![许可证](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](./LICENSE)
1010
[![文档](https://img.shields.io/badge/docs-CC%20BY%204.0-green.svg)](./LICENSE-docs)
11-
[![版本](https://img.shields.io/badge/version-2026--05--06.143421-orange.svg)](#版本历史)
11+
[![版本](https://img.shields.io/badge/version-2026--05--06.181908-orange.svg)](#版本历史)
1212
[![欢迎PR](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)](./CONTRIBUTING_CN.md)
1313

1414
[English](./README.md) · 简体中文 · [快速开始](#快速开始) · [配置说明](#配置说明) · [贡献者](./CONTRIBUTORS.md)
@@ -21,32 +21,41 @@
2121

2222
随着仓库增长,AI 辅助开发会遇到一个隐性问题:决策依据散落在对话里,每次新 session 都要重新理解上下文,用户认知、AI 理解和代码现状会逐渐偏离。
2323

24-
Sopify 用机器可读协议把关键节点变成可见流程:缺事实时停下来补事实,需要拍板时等待你确认,中断后从当前状态恢复,而不是让 AI 自行拍板。基础过程记录会自动产生,长期复利则取决于是否持续做阶段收口和维护知识资产。
24+
Sopify 用项目级约定把关键节点变成可见流程:缺事实时停下来补事实,需要拍板时等待你确认,中断后从当前状态恢复,而不是让 AI 自行拍板。基础过程记录会自动产生,长期复利则取决于是否持续做阶段收口和维护知识资产。
2525

2626
### 你会实际感受到什么
2727

28-
- 关键节点不会由 AI 自行拍板,缺事实或需要选路时会停下来等你确认
29-
- 中断后可以从上次停点恢复,不必重新把背景再讲一遍
30-
- 方案、历史和蓝图会沉淀为项目资产,而不只是一次性聊天记录
31-
- 简单改动不会被完整流程拖慢,复杂任务再补上必要管理
28+
- 中断后从上次停点恢复,即使切换到不同的 AI 宿主或模型也能精确接力
29+
- 复杂变更可在执行前经过隔离的独立审查
30+
- 方案在授权后被修改时,AI 不能静默继续 — 必须重新向你确认
31+
- 方案、决策和审查结论会沉淀为可复用的项目资产,而不是一次性聊天记录
32+
- 缺事实或需要选路时停下来等你确认;简单任务自动简化
3233

3334
### 在哪类项目里最有价值
3435

3536
- 在同一仓库中持续推进多阶段工作,而不是一次性改动
3637
- 愿意用 plan / blueprint 管理进展,并在阶段完成后持续做收口
3738

38-
## 安装后你会得到什么
39+
### 你的 AI 宿主解决不了什么?
3940

40-
- 安装后,你的宿主已可运行 Sopify
41-
- 首次在项目仓库里触发 Sopify 时,才会准备本地 `.sopify-runtime/`
42-
- `status` 用来看当前 host / workspace 状态。
43-
- `doctor` 用来看更深的安装与运行时诊断及修复建议。
44-
45-
本文只聚焦安装可见性、自检与首次使用路径,不展开仓库清理流程。
41+
| 差距 | Sopify 的回答 |
42+
|------|--------------|
43+
| 状态锁定在单一宿主的聊天 session 中 | 可携带的项目状态 — 任务进行中随时切换宿主 |
44+
| 缺少独立质量闸门 | 可在执行前增加隔离的独立审查 |
45+
| 决策不可见、不可审计 | 方案变更后必须重新确认 — AI 不能静默继续 |
46+
| 每个 session 的学习都是一次性的 | 方案、决策、审查结论沉淀为可复用的项目资产 |
4647

4748
## 快速开始
4849

49-
### 安装
50+
根据你的仓库状态,有两种开始方式:
51+
52+
### 已启用 Sopify?直接体验
53+
54+
如果仓库里已有 `.sopify-skills/`,打开任意 AI 宿主(Claude、Cursor、Codex……),让它继续一个未完成的任务。它会从上次停点恢复,而不是从头开始。这就是协议在工作,无需 runtime。
55+
56+
完整 Convention 演练:[protocol.md §4](./.sopify-skills/blueprint/protocol.md#4-典型生命周期样例)
57+
58+
### 首次使用?先安装
5059

5160
```bash
5261
# 推荐:稳定版一行安装
@@ -80,7 +89,7 @@ python3 scripts/install_sopify.py --target claude:zh-CN --workspace /path/to/pro
8089
- `claude:zh-CN`
8190
- `claude:en-US`
8291

83-
当前宿主可用性矩阵
92+
协议层(Convention 模式)适用于任何宿主。当前已验证的 runtime 集成
8493

8594
| 宿主 | 安装 target | 可用性 | 验证范围 | 说明 |
8695
|------|-------------|--------|----------|------|
@@ -99,6 +108,13 @@ python3 scripts/install_sopify.py --target claude:zh-CN --workspace /path/to/pro
99108
- 首次在项目仓库里触发 Sopify 时,才会准备 `.sopify-runtime/`
100109
- `--workspace` 适用于维护者、CI 或显式预热仓库的高级路径
101110

111+
### 安装后你的工作流会怎么变化
112+
113+
- 当你希望 Sopify 帮你管理完整任务流程时,用 `~go` 开始。
114+
- 随时中断 — 回来时(哪怕换了工具)从上次停点继续。
115+
- 复杂变更可以在执行前经过独立审查。
116+
-`status` 查看当前进度,用 `doctor` 排查问题。
117+
102118
### 安装后怎么确认正常
103119

104120
```bash
@@ -110,18 +126,6 @@ python3 scripts/sopify_doctor.py --format text
110126
- `workspace outcome: stub_selected [continue]`:workspace runtime 入口健康
111127
- 如果 doctor 报出 payload 或 bundle 损坏类错误(例如 `global_bundle_missing``global_bundle_incompatible``global_index_corrupted`),先修复安装,再重试
112128

113-
### Convention 模式(无需 Runtime)
114-
115-
如果只需要项目协议,不需要安装 runtime,可以直接使用 Convention 模式:
116-
117-
1. **阅读** `.sopify-skills/blueprint/` 理解项目上下文
118-
2. **创建** `.sopify-skills/plan/YYYYMMDD_feature/plan.md`(需包含 title / scope / approach + 内联 tasks)
119-
3. **归档**`.sopify-skills/history/YYYY-MM/` 并生成 `receipt.md`
120-
121-
完整 Convention 流程见 [protocol.md §4 — 典型生命周期样例](./.sopify-skills/blueprint/protocol.md#4-典型生命周期样例)(样例 A),合规自检见 [protocol.md §5 — 协议合规检查清单](./.sopify-skills/blueprint/protocol.md#5-协议合规检查清单)
122-
123-
任何宿主只要遵循以上三步即为 Convention 合规——无需 runtime、无需安装器、无需 CLI。
124-
125129
### 根据任务规模选入口
126130

127131
| 任务类型 | Sopify 处理方式 |

0 commit comments

Comments
 (0)