Skip to content

Commit 44fceeb

Browse files
zhonghuiCopilot
zhonghui
and
Copilot
committed
feat: move quick-start to section 2 in all READMEs + complete i18n
README changes (all 4 languages): - Move quick-start to section 2 (right after intro) - Replace inline steps with file-pointer table + link to docs site - Renumber remaining sections accordingly VitePress docs: - docs/ja/quick-start.md: Japanese translation - docs/zh-TW/quick-start.md: Traditional Chinese translation - sidebarJa() + sidebarZhTW(): add 使い方ガイド/使用指南 section - docs/ja/index.md + zh-TW/index.md: hero CTA → quick-start Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
1 parent dc95ac6 commit 44fceeb

9 files changed

Lines changed: 534 additions & 206 deletions

File tree

‎README.en.md‎

Lines changed: 21 additions & 51 deletions
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,23 @@ Each Agent is a one-time worker — it has no memory of what it did before. All
3232

3333
---
3434

35-
## 2. Use Cases
35+
## 2. Quick Start
36+
37+
📖 **Full step-by-step guide with copy-paste prompts → [Online Docs](https://lordmos.github.io/tech-editorial/en/quick-start)**
38+
39+
Five phases — launch your AI assistant directly from the Agent spec files:
40+
41+
| Phase | Task | Agent Spec |
42+
|-------|------|-----------|
43+
| Phase 1 | Finalize Outline | [`agents/02-architect.md`](agents/02-architect.md), [`agents/03-reader-advocate.md`](agents/03-reader-advocate.md) |
44+
| Phase 2 | Build Shared Resources | [`agents/01-orchestrator.md`](agents/01-orchestrator.md) |
45+
| Phase 3 | Write Chapters | [`agents/04-researcher.md`](agents/04-researcher.md), [`agents/05-writer.md`](agents/05-writer.md) |
46+
| Phase 4 | Triple Review (parallel) | [`agents/06-code-reviewer.md`](agents/06-code-reviewer.md), [`agents/07-consistency-reviewer.md`](agents/07-consistency-reviewer.md), [`agents/08-content-reviewer.md`](agents/08-content-reviewer.md) |
47+
| Phase 5 | Publish | [`agents/10-bookbinder.md`](agents/10-bookbinder.md) |
48+
49+
Progress tracking: [`templates/checkpoint.md`](templates/checkpoint.md)　　Checkpoint recovery: [`framework/recovery.md`](framework/recovery.md)
50+
51+
## 3. Use Cases
3652

3753
This framework is suited for the following types of technical book projects:
3854

@@ -45,7 +61,7 @@ This framework is suited for the following types of technical book projects:
4561

4662
---
4763

48-
## 3. System Architecture Overview
64+
## 4. System Architecture Overview
4965

5066
This framework uses a **Hub-Spoke architecture**:
5167

@@ -67,7 +83,7 @@ This framework uses a **Hub-Spoke architecture**:
6783

6884
---
6985

70-
## 4. Agent Team Directory
86+
## 5. Agent Team Directory
7187

7288
| ID | Name | Role Metaphor | Agent Type | Responsibilities |
7389
|------|------|----------|-----------|------|
@@ -86,7 +102,7 @@ This framework uses a **Hub-Spoke architecture**:
86102

87103
---
88104

89-
## 5. Five-Phase Workflow Overview
105+
## 6. Five-Phase Workflow Overview
90106

91107
```
92108
Phase 1 ──→ Phase 2 ──→ Phase 3 ──→ Phase 4 ──→ Phase 5
@@ -140,7 +156,7 @@ Executes Markdown → HTML conversion, **Mermaid diagram rendering** (via Mermai
140156

141157
---
142158

143-
## 6. Directory Structure
159+
## 7. Directory Structure
144160

145161
```
146162
tech-editorial/
@@ -184,52 +200,6 @@ tech-editorial/
184200

185201
---
186202

187-
## 7. Quick Start
188-
189-
### Step 1: Copy the Framework
190-
191-
```bash
192-
cp -r tech-editorial/ {{你的项目路径}}/editorial/
193-
```
194-
195-
### Step 2: Fill in the Templates
196-
197-
Go to the `templates/` directory and fill in the core templates:
198-
199-
| Template File | Content to Fill In |
200-
|---------|--------------|
201-
| `source-map.md` | Target source code directory structure, core module descriptions, key file paths |
202-
| `outline.md` | Initial chapter outline (can be generated with assistance from the Architect Agent) |
203-
| `style-guide.md` | Writing style preferences, code presentation rules, reader positioning |
204-
| `glossary.md` | Initial translations/definitions of known terms (Agents will add more later) |
205-
| `metaphor-registry.md` | Leave blank; fill in progressively during the writing process |
206-
207-
### Step 3: Configure the Orchestrator Agent
208-
209-
In the startup prompt for the Orchestrator Agent, set the following project parameters:
210-
211-
```yaml
212-
项目名称: {{项目名称}}
213-
源码仓库: {{源码仓库地址}}
214-
源码版本: {{源码版本/commit}}
215-
章节总数: {{章节数}}
216-
并行批次: {{并行批次数}} # 每批同时写作的章节数
217-
目标读者: {{目标读者描述}}
218-
输出目录: {{输出目录路径}}
219-
```
220-
221-
### Step 4: Advance Phase by Phase
222-
223-
Execute Phases 1 → 5 in sequence. Confirm deliverables after each Phase before proceeding to the next:
224-
225-
1. **Phase 1**: Launch Architect → Reader Advocate reviews → User approves outline
226-
2. **Phase 2**: Orchestrator generates shared resource files
227-
3. **Phase 3**: Chapter by chapter (or in parallel batches): Research → Write → Review → Reader Review
228-
4. **Phase 4**: Full-book comprehensive audit
229-
5. **Phase 5**: Bookbinder generates HTML publication
230-
231-
---
232-
233203
## 8. Core Design Principles
234204

235205
### Principle 1: Agents Are Stateless; the File System Is Stateful

‎README.ja.md‎

Lines changed: 21 additions & 51 deletions
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,23 @@
3434

3535
---
3636

37-
## 2. 適用シナリオ
37+
## 2. クイックスタート
38+
39+
📖 **完全な操作ガイド（Agent 呼び出しプロンプト付き）→ [オンラインドキュメント](https://lordmos.github.io/tech-editorial/ja/quick-start)**
40+
41+
5 つのフェーズ — 対応する Agent 仕様ファイルから AI アシスタントを直接起動：
42+
43+
| フェーズ | タスク | Agent 仕様 |
44+
|---------|--------|-----------|
45+
| Phase 1 | アウトライン確定 | [`agents/02-architect.md`](agents/02-architect.md)、[`agents/03-reader-advocate.md`](agents/03-reader-advocate.md) |
46+
| Phase 2 | 共有リソース構築 | [`agents/01-orchestrator.md`](agents/01-orchestrator.md) |
47+
| Phase 3 | 逐章執筆 | [`agents/04-researcher.md`](agents/04-researcher.md)、[`agents/05-writer.md`](agents/05-writer.md) |
48+
| Phase 4 | 三並行レビュー | [`agents/06-code-reviewer.md`](agents/06-code-reviewer.md)、[`agents/07-consistency-reviewer.md`](agents/07-consistency-reviewer.md)、[`agents/08-content-reviewer.md`](agents/08-content-reviewer.md) |
49+
| Phase 5 | 出版 | [`agents/10-bookbinder.md`](agents/10-bookbinder.md) |
50+
51+
進捗管理：[`templates/checkpoint.md`](templates/checkpoint.md)　　チェックポイント回復：[`framework/recovery.md`](framework/recovery.md)
52+
53+
## 3. 適用シナリオ
3854

3955
本フレームワークは以下の種類の技術書籍プロジェクトに適しています：
4056

@@ -47,7 +63,7 @@
4763

4864
---
4965

50-
## 3. システムアーキテクチャ概要
66+
## 4. システムアーキテクチャ概要
5167

5268
本フレームワークは **Hub-Spoke（ハブアンドスポーク）アーキテクチャ**を採用しています：
5369

@@ -69,7 +85,7 @@
6985

7086
---
7187

72-
## 4. Agentチーム一覧
88+
## 5. Agentチーム一覧
7389

7490
| 番号 | 名前 | ロール比喩 | Agentタイプ | 担当 |
7591
|------|------|----------|-----------|------|
@@ -88,7 +104,7 @@
88104

89105
---
90106

91-
## 5. 5段階ワークフロー概要
107+
## 6. 5段階ワークフロー概要
92108

93109
```
94110
Phase 1 ──→ Phase 2 ──→ Phase 3 ──→ Phase 4 ──→ Phase 5
@@ -141,7 +157,7 @@ Markdown→HTML変換、**Mermaid図のレンダリング**（Mermaid.jsを使
141157

142158
---
143159

144-
## 6. ディレクトリ構成
160+
## 7. ディレクトリ構成
145161

146162
```
147163
tech-editorial/
@@ -185,52 +201,6 @@ tech-editorial/
185201

186202
---
187203

188-
## 7. クイックスタート
189-
190-
### Step 1：フレームワークをコピーする
191-
192-
```bash
193-
cp -r tech-editorial/ {{あなたのプロジェクトパス}}/editorial/
194-
```
195-
196-
### Step 2：テンプレートを記入する
197-
198-
`templates/` ディレクトリに入り、以下のコアテンプレートを記入します：
199-
200-
| テンプレートファイル | 記入する内容 |
201-
|---------|--------------|
202-
| `source-map.md` | 対象ソースコードのディレクトリ構造、コアモジュールの説明、重要なファイルパス |
203-
| `outline.md` | 初期章のアウトライン（アーキテクトAgentが補助生成可能） |
204-
| `style-guide.md` | ライティングスタイルの好み、コード表示規則、読者定義 |
205-
| `glossary.md` | 既知の用語の初期翻訳・定義（後でAgentが補完） |
206-
| `metaphor-registry.md` | 空白のままでOK。執筆プロセスで徐々に埋まっていきます |
207-
208-
### Step 3：メインオーケストレーターAgentを設定する
209-
210-
メインオーケストレーターAgentの起動プロンプトで、以下のプロジェクトパラメータを設定します：
211-
212-
```yaml
213-
项目名称: {{プロジェクト名}}
214-
源码仓库: {{ソースコードリポジトリURL}}
215-
源码版本: {{ソースコードバージョン/commit}}
216-
章节总数: {{章数}}
217-
并行批次: {{並行バッチ数}} # 同時に執筆する章数
218-
目标读者: {{対象読者の説明}}
219-
输出目录: {{出力ディレクトリパス}}
220-
```
221-
222-
### Step 4：フェーズごとに進める
223-
224-
Phase 1〜5を順番に実行し、各フェーズ完了後に成果物を確認してから次のフェーズに進みます：
225-
226-
1. **Phase 1**：アーキテクトを起動 → リーダーアドボケイトによる審査 → ユーザーがアウトラインを承認
227-
2. **Phase 2**：メインオーケストレーターが共有リソースファイルを生成
228-
3. **Phase 3**：章ごと（またはバッチ並行）にリサーチ→執筆→レビュー→評価を実行
229-
4. **Phase 4**：書籍全体の原稿統合・最終監査
230-
5. **Phase 5**：ブックバインダーがHTML発行物を生成
231-
232-
---
233-
234204
## 8. コア設計原則
235205

236206
### 原則 1：Agentはステートレス、ファイルシステムはステートフル

‎README.md‎

Lines changed: 21 additions & 51 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,23 @@
2424

2525
---
2626

27-
## 2. 适用场景
27+
## 2. 快速开始
28+
29+
📖 **完整操作指南（含逐步 Agent 调用提示词）→ [在线文档](https://lordmos.github.io/tech-editorial/quick-start)**
30+
31+
五个阶段，直接使用对应 Agent 规格文件启动 AI 助手：
32+
33+
| 阶段 | 任务 | Agent 规格 |
34+
|------|------|-----------|
35+
| Phase 1 | 大纲定稿 | [`agents/02-architect.md`](agents/02-architect.md)、[`agents/03-reader-advocate.md`](agents/03-reader-advocate.md) |
36+
| Phase 2 | 共享资源构建 | [`agents/01-orchestrator.md`](agents/01-orchestrator.md) |
37+
| Phase 3 | 逐章写作 | [`agents/04-researcher.md`](agents/04-researcher.md)、[`agents/05-writer.md`](agents/05-writer.md) |
38+
| Phase 4 | 三审并行 | [`agents/06-code-reviewer.md`](agents/06-code-reviewer.md)、[`agents/07-consistency-reviewer.md`](agents/07-consistency-reviewer.md)、[`agents/08-content-reviewer.md`](agents/08-content-reviewer.md) |
39+
| Phase 5 | 装帧发布 | [`agents/10-bookbinder.md`](agents/10-bookbinder.md) |
40+
41+
进度追踪：[`templates/checkpoint.md`](templates/checkpoint.md)　　断点恢复：[`framework/recovery.md`](framework/recovery.md)
42+
43+
## 3. 适用场景
2844

2945
本框架适用于以下类型的技术书籍项目：
3046

@@ -37,7 +53,7 @@
3753

3854
---
3955

40-
## 3. 系统架构概览
56+
## 4. 系统架构概览
4157

4258
本框架采用 **Hub-Spoke（轴辐式）架构**：
4359

@@ -59,7 +75,7 @@
5975

6076
---
6177

62-
## 4. Agent 团队一览表
78+
## 5. Agent 团队一览表
6379

6480
| 编号 | 名称 | 角色隐喻 | Agent 类型 | 职责 |
6581
|------|------|----------|-----------|------|
@@ -78,7 +94,7 @@
7894

7995
---
8096

81-
## 5. 五阶段工作流概览
97+
## 6. 五阶段工作流概览
8298

8399
```
84100
Phase 1 ──→ Phase 2 ──→ Phase 3 ──→ Phase 4 ──→ Phase 5
@@ -131,7 +147,7 @@ Phase 1 ──→ Phase 2 ──→ Phase 3 ──→ Phase 4 ──→ Phase 5
131147

132148
---
133149

134-
## 6. 目录结构
150+
## 7. 目录结构
135151

136152
```
137153
tech-editorial/
@@ -175,52 +191,6 @@ tech-editorial/
175191

176192
---
177193

178-
## 7. 快速开始
179-
180-
### Step 1：复制框架
181-
182-
```bash
183-
cp -r tech-editorial/ {{你的项目路径}}/editorial/
184-
```
185-
186-
### Step 2：填写模板
187-
188-
进入 `templates/` 目录，填写以下核心模板：
189-
190-
| 模板文件 | 需要填写的内容 |
191-
|---------|--------------|
192-
| `source-map.md` | 目标源码的目录结构、核心模块说明、关键文件路径 |
193-
| `outline.md` | 初始章节大纲（可由架构师 Agent 辅助生成） |
194-
| `style-guide.md` | 写作风格偏好、代码展示规范、读者定位 |
195-
| `glossary.md` | 已知术语的初始翻译/定义（后续由 Agent 补充） |
196-
| `metaphor-registry.md` | 留空即可，由写作过程中逐步填充 |
197-
198-
### Step 3：配置主编排 Agent
199-
200-
在主编排 Agent 的启动提示词中，设定以下项目参数：
201-
202-
```yaml
203-
项目名称: {{项目名称}}
204-
源码仓库: {{源码仓库地址}}
205-
源码版本: {{源码版本/commit}}
206-
章节总数: {{章节数}}
207-
并行批次: {{并行批次数}} # 每批同时写作的章节数
208-
目标读者: {{目标读者描述}}
209-
输出目录: {{输出目录路径}}
210-
```
211-
212-
### Step 4：按阶段推进
213-
214-
依次执行 Phase 1→5，每个 Phase 完成后确认产出物再进入下一阶段：
215-
216-
1. **Phase 1**：启动架构师 → 读者代言人审核 → 用户审批大纲
217-
2. **Phase 2**：主编排生成共享资源文件
218-
3. **Phase 3**：逐章（或分批并行）执行 研究→撰写→审查→评审
219-
4. **Phase 4**：全书统稿审计
220-
5. **Phase 5**：装帧工人生成 HTML 发布物
221-
222-
---
223-
224194
## 8. 核心设计原则
225195

226196
### 原则 1：Agent 无状态，文件系统有状态

0 commit comments

Comments
 (0)