aimship 0.1.0-preview.11 → 0.1.0-preview.13
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CONTRIBUTING.md +3 -3
- package/README.md +6 -10
- package/README.zh-CN.md +6 -10
- package/docs/cli.md +23 -25
- package/docs/guide.md +314 -148
- package/docs/guide.zh-CN.md +314 -148
- package/lib/approvals.mjs +77 -13
- package/lib/cli.mjs +27 -21
- package/lib/delivery.mjs +15 -12
- package/lib/discovery.mjs +25 -0
- package/lib/documents.mjs +159 -65
- package/lib/install.mjs +1 -1
- package/lib/language.mjs +41 -0
- package/lib/location.mjs +65 -0
- package/lib/state.mjs +54 -87
- package/lib/view.mjs +36 -34
- package/package.json +1 -1
- package/skills/aimship/SKILL.md +3 -3
- package/skills/aimship/references/artifact-map.json +165 -9
- package/skills/aimship/references/core.md +17 -13
- package/skills/aimship/references/document-patterns.md +17 -11
- package/skills/aimship/references/document-review.md +1 -3
- package/skills/aimship/references/hosts.md +11 -9
- package/skills/aimship/references/recovery.md +9 -13
- package/skills/aimship/references/sources-and-changes.md +11 -4
- package/skills/aimship/references/stages/diagnose.md +1 -1
- package/skills/aimship/references/stages/frame.md +1 -1
- package/skills/aimship/references/stages/handoff.md +1 -1
- package/skills/aimship/references/stages/implement.md +2 -2
- package/skills/aimship/references/stages/plan.md +1 -1
- package/skills/aimship/references/stages/requirements.md +1 -1
- package/skills/aimship/references/stages/review.md +1 -1
- package/skills/aimship/references/stages/scope.md +1 -1
- package/skills/aimship/references/stages/tech-design.md +1 -1
- package/skills/aimship/references/stages/test-design.md +1 -1
- package/skills/aimship/references/stages/verify.md +2 -2
- package/skills/aimship/references/templates/change-log.md +0 -2
- package/skills/aimship/references/templates/diagnosis.md +0 -7
- package/skills/aimship/references/templates/handoff.md +0 -6
- package/skills/aimship/references/templates/plan.md +2 -8
- package/skills/aimship/references/templates/prd.md +0 -7
- package/skills/aimship/references/templates/review.md +0 -3
- package/skills/aimship/references/templates/scope.md +0 -7
- package/skills/aimship/references/templates/tech-design.md +0 -7
- package/skills/aimship/references/templates/testing.md +2 -8
- package/lib/migrate.mjs +0 -77
package/docs/guide.zh-CN.md
CHANGED
|
@@ -2,242 +2,408 @@
|
|
|
2
2
|
|
|
3
3
|
[English](guide.md) · [README](../README.zh-CN.md)
|
|
4
4
|
|
|
5
|
-
|
|
5
|
+
[交付目录](#delivery-structure) · [1. 使用示例](#start) · [2. 会话与续接](#guide-sessions) · [3. 需求输入与变更](#guide-inputs) · [4. 代码与多需求管理](#guide-projects) · [5. 问题处理与维护](#troubleshoot)
|
|
6
6
|
|
|
7
|
-
<a id="
|
|
8
|
-
|
|
7
|
+
<a id="24-查看当前工作"></a>
|
|
8
|
+
<a id="44-交付目录与文档"></a>
|
|
9
|
+
<a id="results"></a>
|
|
10
|
+
<a id="3-查看进度与成果"></a>
|
|
11
|
+
<a id="4-查看进度与成果"></a>
|
|
12
|
+
<a id="4-查看进度与验收成果"></a>
|
|
13
|
+
<a id="查看当前工作"></a>
|
|
14
|
+
<a id="artifacts"></a>
|
|
15
|
+
<a id="keep-only-useful-artifacts"></a>
|
|
16
|
+
<a id="相关参考"></a>
|
|
17
|
+
<a id="附录sql-与工程版本"></a>
|
|
18
|
+
<a id="document-details"></a>
|
|
19
|
+
<a id="sql变更和进度"></a>
|
|
20
|
+
<a id="sql-与工程版本"></a>
|
|
21
|
+
<a id="delivery-structure"></a>
|
|
22
|
+
<a id="阶段产物与内容"></a>
|
|
23
|
+
<a id="交付目录与文档"></a>
|
|
24
|
+
<a id="固定大纲和可追溯编号"></a>
|
|
25
|
+
<a id="guide-directory"></a>
|
|
9
26
|
|
|
10
|
-
|
|
27
|
+
## 交付目录速览
|
|
11
28
|
|
|
12
|
-
|
|
13
|
-
<a id="1-在宿主中选择-aimship"></a>
|
|
14
|
-
<a id="1-在-ai-开发工具中选择-aimship"></a>
|
|
15
|
-
## 1. 在 AI 工具中选择 Aimship
|
|
29
|
+
默认资料根目录为用户主目录下的 `~/Aimship/`,安装时另有配置则沿用。**每次交付在该根目录下独立存放,以 AI 回执中的实际路径为准**;需要另存时请明确说明。
|
|
16
30
|
|
|
17
|
-
|
|
31
|
+
在 AI 工具项目空间中开展交付,空间中同时访问原有材料和 Aimship 交付目录:
|
|
18
32
|
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
33
|
+
```text
|
|
34
|
+
AI 工具项目空间
|
|
35
|
+
├── 用户已有项目材料(按实际情况提供,保留原位置)
|
|
36
|
+
│ ├── 原型、PRD、其他参考文档(如已有)
|
|
37
|
+
│ └── 项目代码(如已有)
|
|
38
|
+
└── Aimship 初始化生成的本次需求交付目录
|
|
39
|
+
└── 添加原目录 → ~/Aimship/20261027-login-signup/
|
|
40
|
+
```
|
|
41
|
+
|
|
42
|
+
按下方[启用并提出诉求](#guide-setup)完成初始化,收到实际路径后,将该交付文件夹(本例为 `20261027-login-signup`)添加到当前 AI 工具项目空间,或授予该目录的访问权限,后续在这个空间继续交付。已有项目材料按需要提供访问,不由 Aimship 初始化创建。目录名仅为示例,无需提前手工创建,也不要复制整份交付或在项目空间另建一套。
|
|
24
43
|
|
|
25
|
-
|
|
44
|
+
该交付目录中的材料如下:
|
|
45
|
+
|
|
46
|
+
```text
|
|
47
|
+
~/Aimship/ # 资料根目录
|
|
48
|
+
└── 20261027-login-signup/ # 示例交付目录
|
|
49
|
+
├── status.md # 当前工作、待审材料、下一步
|
|
50
|
+
├── source/request.md # 原始诉求
|
|
51
|
+
├── prd.md # 需求与验收标准
|
|
52
|
+
├── prototype/index.html # 页面交互原型
|
|
53
|
+
├── tech-design.md # 技术方案
|
|
54
|
+
├── openapi.yaml # HTTP 接口契约
|
|
55
|
+
├── database.sql # 本例单数据库变更
|
|
56
|
+
├── testing.md # 用例与后续执行结果
|
|
57
|
+
├── plan.md # 实施任务与进度
|
|
58
|
+
├── review.md # 各批及整体审查
|
|
59
|
+
└── handoff.md # 成果与交接说明
|
|
60
|
+
```
|
|
26
61
|
|
|
27
|
-
|
|
62
|
+
这些材料逐步形成,按需保留。正文中的 REQ、AC、TC 等编号可直接搜索,跨文档沿用对应编号,不要求锚点跳转。外部权威需求由 `scope.md` 承接,重要变更记入 `change-log.md`,独立调查才使用 `diagnosis.md`。查看进度先打开 `status.md`;需求修改或验收意见直接告诉 AI。
|
|
28
63
|
|
|
64
|
+
<a id="1-开始与推进"></a>
|
|
29
65
|
<a id="start"></a>
|
|
30
66
|
<a id="需求依据与输入条件"></a>
|
|
31
67
|
<a id="describe-the-work-and-its-endpoint"></a>
|
|
32
|
-
|
|
68
|
+
<a id="2-不同场景下如何开始"></a>
|
|
69
|
+
<a id="1-首次使用"></a>
|
|
70
|
+
<a id="guide-example"></a>
|
|
71
|
+
<a id="1-登录注册功能一次交付示例"></a>
|
|
72
|
+
|
|
73
|
+
<a id="1-aimship-交付演示"></a>
|
|
74
|
+
|
|
75
|
+
## 1. Aimship 使用示例
|
|
76
|
+
|
|
77
|
+
以登录注册功能演示从需求到验收。**这是虚构实践参考,措辞和业务方案无需照抄。** 本例稍后提供工程和隔离测试数据库,约定需求后确认原型,再做技术设计;实际原型安排按交付需要确定。
|
|
78
|
+
|
|
79
|
+
同一会话沿用一个 Aimship 入口,批准后按安排继续,无需逐阶段调用。需要你审核时,AI 会逐份展示材料并等待明确结论;修改后重新送审。
|
|
80
|
+
|
|
81
|
+
<a id="11-准备工作位置"></a>
|
|
82
|
+
<a id="12-启用-aimship-并说明需求"></a>
|
|
83
|
+
<a id="13-确认保存结果并回答必要问题"></a>
|
|
84
|
+
<a id="准备工作位置"></a>
|
|
85
|
+
<a id="hosts"></a>
|
|
86
|
+
<a id="1-在宿主中选择-aimship"></a>
|
|
87
|
+
<a id="1-在-ai-开发工具中选择-aimship"></a>
|
|
88
|
+
<a id="1-在-ai-工具中选择-aimship"></a>
|
|
89
|
+
<a id="启用-aimship-并说明需求"></a>
|
|
90
|
+
<a id="确认保存结果并回答必要问题"></a>
|
|
91
|
+
<a id="install"></a>
|
|
92
|
+
<a id="尚未形成需求文档"></a>
|
|
93
|
+
<a id="guide-setup"></a>
|
|
33
94
|
|
|
34
|
-
|
|
95
|
+
### 1.1 启用并提出诉求
|
|
35
96
|
|
|
36
|
-
|
|
97
|
+
**用户操作**:明确使用 Aimship,并说明目标。例如:
|
|
37
98
|
|
|
38
|
-
|
|
99
|
+
> 使用 Aimship,做用户名密码注册、登录、退出和登录后首页。完成开发与本地验证,不部署;代码稍后提供。
|
|
39
100
|
|
|
40
|
-
|
|
101
|
+
已有原型、PRD 或其他文档时,提供原位置即可,原件保留,用户无需手动复制。AI 按来源规则将正式采用的版本及必要依赖资源留存为本次交付 `source/` 中的副本,并记录采用依据;仅作背景参考的材料无需全量复制。后续修改先明确编辑对象,新版不覆盖旧依据。
|
|
41
102
|
|
|
42
|
-
|
|
103
|
+
**AI 处理**:确定交付目录并核对访问,保留诉求,建立或续接交付,告知实际保存目录、当前工作和下一步。若无法访问,提示你添加该原目录或授权;不会改存到项目空间。
|
|
43
104
|
|
|
44
|
-
|
|
105
|
+
**输出产物**:`source/request.md` 保存原话;`status.md` 显示进度。新建交付时,AI 优先按明确偏好,否则按当前交流语言保存本次交付语言;状态和新文档沿用,文件名、编号、来源原文及已有文档不变。
|
|
45
106
|
|
|
46
|
-
|
|
107
|
+
<a id="14-阅读文档并给出结论"></a>
|
|
108
|
+
<a id="15-批准后继续推进"></a>
|
|
109
|
+
<a id="review"></a>
|
|
110
|
+
<a id="逐份审核与自动衔接"></a>
|
|
111
|
+
<a id="3-推进与审核"></a>
|
|
112
|
+
<a id="2-审核并推进工作"></a>
|
|
113
|
+
<a id="阅读文档并给出结论"></a>
|
|
114
|
+
<a id="批准后继续推进"></a>
|
|
115
|
+
<a id="guide-requirements"></a>
|
|
116
|
+
<a id="guide-prototype"></a>
|
|
117
|
+
<a id="12-确认需求与验收标准"></a>
|
|
118
|
+
<a id="13-确认页面与交互原型"></a>
|
|
47
119
|
|
|
48
|
-
|
|
120
|
+
### 1.2 确认需求
|
|
49
121
|
|
|
50
|
-
|
|
122
|
+
**用户操作**:按已有材料提供输入。
|
|
51
123
|
|
|
52
|
-
|
|
124
|
+
- 没有 PRD/原型:说明功能和预期行为,如“用户名不能重复,退出后再进首页必须登录”。
|
|
125
|
+
- 已有材料:给出 PRD/原型的位置、版本和本次采用范围;只有部分材料也直接说明。
|
|
53
126
|
|
|
54
|
-
|
|
127
|
+
分别打开送审的需求文档和适用原型,核对范围、验收标准及页面行为。每次对当前一份明确通过,或指出要修改的内容。
|
|
55
128
|
|
|
56
|
-
|
|
129
|
+
**AI 处理**:澄清缺口;外部权威原件保留,覆盖充分的原型复用。无材料时先写需求,批准后按本例安排制作所需原型;无交互变化则不新增。逐份自检、送审,批准后保存再继续。
|
|
57
130
|
|
|
58
|
-
|
|
131
|
+
**输出产物**:`prd.md` 说明需求与验收标准,或 `scope.md` 记录外部材料的采用范围;本例新建 `prototype/index.html` 展示页面与反馈状态。原型不代表认证已实现,未实际检查的交互仍标明未验证。
|
|
59
132
|
|
|
60
|
-
|
|
133
|
+
<a id="guide-session-example"></a>
|
|
61
134
|
|
|
62
|
-
|
|
135
|
+
**换会话示例**:本例需求与原型通过并保存后,停止旧会话写入,在新会话明确启用:
|
|
63
136
|
|
|
64
|
-
|
|
137
|
+
> 使用 Aimship 继续「实际交付目录」的登录注册交付,先读取状态、已批准材料和待审核停点。
|
|
65
138
|
|
|
66
|
-
|
|
67
|
-
<a id="逐份审核与自动衔接"></a>
|
|
68
|
-
## 3. 推进与审核
|
|
139
|
+
AI 重新核对同一交付目录的访问,读取状态并确认下一步技术设计;若仍有待审材料就停在那里,不重建或要求重述全部背景。也可留在原会话继续。
|
|
69
140
|
|
|
70
|
-
|
|
141
|
+
<a id="guide-design"></a>
|
|
142
|
+
<a id="14-审核技术方案"></a>
|
|
71
143
|
|
|
72
|
-
|
|
144
|
+
### 1.3 审核技术方案
|
|
73
145
|
|
|
74
|
-
|
|
146
|
+
**用户操作**:提供工程位置及已知测试条件;打开方案,检查密码保护、登录状态、访问控制和数据变更,明确通过或反馈。
|
|
75
147
|
|
|
76
|
-
|
|
148
|
+
**AI 处理**:读取工程,核对技术条件,设计实现方式及风险处理;缺少关键事实先补齐,方案批准后准备接口与 SQL。
|
|
77
149
|
|
|
78
|
-
|
|
150
|
+
**输出产物**:`tech-design.md` 说明怎样实现及取舍。此时设计后续 SQL,不要求 SQL 文件已经完成。
|
|
79
151
|
|
|
80
|
-
<a id="
|
|
81
|
-
<a id="
|
|
82
|
-
## 4. 查看进度与成果
|
|
152
|
+
<a id="guide-contracts"></a>
|
|
153
|
+
<a id="15-逐份审核接口与-sql"></a>
|
|
83
154
|
|
|
84
|
-
|
|
155
|
+
### 1.4 逐份审核接口与 SQL
|
|
85
156
|
|
|
86
|
-
|
|
87
|
-
<a id="阶段产物与内容"></a>
|
|
88
|
-
### 交付目录与文档
|
|
157
|
+
**用户操作**:接口送审时检查请求、响应、错误与登录要求;SQL 送审时检查目标库、结构、变更顺序及执行条件,分别通过或要求修改。
|
|
89
158
|
|
|
90
|
-
|
|
159
|
+
**AI 处理**:依据已批准方案准备适用文档,逐份自检并等待审核;全部通过后进入测试设计。已有权威契约复用,无对应变更不生成文件,多数据库分别提供 SQL。
|
|
91
160
|
|
|
92
|
-
|
|
161
|
+
**输出产物**:本例 `openapi.yaml` 约定 HTTP 接口,`database.sql` 描述单库变更。**文档批准不授权执行 SQL 或修改迁移机制。**
|
|
93
162
|
|
|
94
|
-
|
|
95
|
-
|
|
96
|
-
├── 20261023-订单导出/ # 每个需求一个独立交付目录
|
|
97
|
-
│ ├── status.md # 自动生成的进度总览和阅读入口
|
|
98
|
-
│ ├── prd.md # 自编需求:目标、范围、需求和验收标准
|
|
99
|
-
│ ├── scope.md # 采用权威外部资料时使用,替代自编 PRD
|
|
100
|
-
│ ├── tech-design.md # 技术方案:架构、改动、数据、风险和需求覆盖
|
|
101
|
-
│ ├── plan.md # 实施计划:批次、任务及实际执行记录
|
|
102
|
-
│ ├── testing.md # 测试用例、覆盖关系、执行与重测结果
|
|
103
|
-
│ ├── review.md # 各批及整体审核、发现的问题和处理结论
|
|
104
|
-
│ ├── handoff.md # 交付结果、使用方式、验证结论和遗留事项
|
|
105
|
-
│ ├── diagnosis.md # 仅独立调查时生成的定位与证据记录
|
|
106
|
-
│ ├── change-log.md # 重要变更、决定及受影响的工作
|
|
107
|
-
│ ├── openapi.yaml # 新建 HTTP 契约;已有权威契约优先复用
|
|
108
|
-
│ ├── database.sql # 单数据库 SQL;多目标为 database-<id>.sql
|
|
109
|
-
│ ├── prototype/ # 符合生成条件时新建的原型
|
|
110
|
-
│ │ └── index.html # HTML 原型入口,相关资源也放在此目录
|
|
111
|
-
│ ├── source/ # 保留原始需求和采用的外部资料版本
|
|
112
|
-
│ │ ├── request.md # 原始委托或来源入口
|
|
113
|
-
│ │ └── … # 外部 PRD、原型、截图及其他输入
|
|
114
|
-
│ └── .aimship/ # 工具维护的内部状态与辅助证据
|
|
115
|
-
│ ├── state.json # 阶段、引用、版本及仓库/worktree 关联
|
|
116
|
-
│ ├── state.previous.json # 写入后用于恢复的上一版状态
|
|
117
|
-
│ ├── view.json # 进度视图的生成元信息
|
|
118
|
-
│ └── evidence/ # 按需保留的验证等证据
|
|
119
|
-
└── 20261024-另一个需求/ # 独立的资料与进度
|
|
120
|
-
```
|
|
163
|
+
<a id="guide-cases"></a>
|
|
164
|
+
<a id="16-审核测试用例"></a>
|
|
121
165
|
|
|
122
|
-
|
|
166
|
+
### 1.5 审核测试用例
|
|
123
167
|
|
|
124
|
-
|
|
125
|
-
需求、验收标准、实施任务、审核和测试结果之间的关联由 Agent 维护,便于追溯。
|
|
168
|
+
**用户操作**:打开用例,核对正常注册登录、重复用户名、错误密码、未登录访问及退出后访问的预期结果;通过或指出遗漏。
|
|
126
169
|
|
|
127
|
-
|
|
128
|
-
|
|
129
|
-
|
|
130
|
-
|
|
170
|
+
**AI 处理**:将验收标准转为可检查的用例,注明环境与覆盖范围;用例批准后制定实施计划。
|
|
171
|
+
|
|
172
|
+
**输出产物**:`testing.md` 的用例部分。这时还没有测试执行结果。
|
|
173
|
+
|
|
174
|
+
<a id="guide-plan"></a>
|
|
175
|
+
<a id="17-审核实施计划"></a>
|
|
176
|
+
|
|
177
|
+
### 1.6 审核实施计划
|
|
178
|
+
|
|
179
|
+
**用户操作**:打开计划,核对改动范围、任务依赖、分批与验证安排;通过或反馈。
|
|
180
|
+
|
|
181
|
+
**AI 处理**:按工程依赖拆任务,如先完成认证与会话,再接页面和访问限制,安排测试代码及审查;计划与必要文档批准后才实施,单批也需要计划。
|
|
182
|
+
|
|
183
|
+
**输出产物**:`plan.md` 说明各批做什么、依赖什么、如何检查。
|
|
184
|
+
|
|
185
|
+
<a id="guide-implement"></a>
|
|
186
|
+
<a id="18-分批实施与批内-review"></a>
|
|
187
|
+
|
|
188
|
+
### 1.7 分批实施与批内 review
|
|
131
189
|
|
|
132
|
-
|
|
190
|
+
**用户操作**:查看改动和进度,有偏离及时指出,如“注册成功后的跳转与原型不一致”。无需逐条批准执行日志。
|
|
133
191
|
|
|
134
|
-
|
|
192
|
+
**AI 处理**:按计划写代码,每批完成后审查并处理阻碍推进的问题,再进入下一批。全部批次完成后做整体审查,再统一验证;需求变化回到相应审核。
|
|
135
193
|
|
|
136
|
-
|
|
194
|
+
**输出产物**:工程代码;`plan.md` 追加执行进度,`review.md` 记录本批问题与修复。
|
|
137
195
|
|
|
138
|
-
|
|
196
|
+
<a id="guide-overall"></a>
|
|
197
|
+
<a id="19-整体-review"></a>
|
|
139
198
|
|
|
199
|
+
### 1.8 整体 review
|
|
200
|
+
|
|
201
|
+
**用户操作**:查看整体结论和遗留问题,必要时指出遗漏;不需要为每条审查记录另做文档批准。
|
|
202
|
+
|
|
203
|
+
**AI 处理**:检查全部实际改动及注册、登录、退出、首页访问的跨批衔接,处理阻碍验证的问题后进入独立验证。单批可用一份 review 明确覆盖批内及整体范围。
|
|
204
|
+
|
|
205
|
+
**输出产物**:`review.md` 追加整体审查结论。代码审查不能代替运行测试。
|
|
206
|
+
|
|
207
|
+
<a id="guide-verify"></a>
|
|
208
|
+
<a id="110-执行验证并处理失败"></a>
|
|
209
|
+
|
|
210
|
+
### 1.9 执行验证并处理失败
|
|
211
|
+
|
|
212
|
+
**用户操作**:提供约定的隔离测试环境,查看执行结果,补充复现信息或缺失条件;另需授权的操作先明确目标与动作。
|
|
213
|
+
|
|
214
|
+
**AI 处理**:对已 review 的代码执行用例,分别记录通过、失败、未执行。缺陷修复后审查并复测,保留失败历史;需求或设计问题回到相应材料。
|
|
215
|
+
|
|
216
|
+
**输出产物**:同一 `testing.md` 追加实际代码、环境、结果与证据。缺少必要验证时如实列出,不写成通过。
|
|
217
|
+
|
|
218
|
+
<a id="25-验收交付成果"></a>
|
|
219
|
+
<a id="completion"></a>
|
|
220
|
+
<a id="decide-when-work-is-done"></a>
|
|
221
|
+
<a id="7-完成交付"></a>
|
|
222
|
+
<a id="8-完成交付"></a>
|
|
223
|
+
<a id="验收交付成果"></a>
|
|
224
|
+
<a id="guide-handoff"></a>
|
|
225
|
+
<a id="111-查看成果并验收"></a>
|
|
226
|
+
|
|
227
|
+
### 1.10 查看成果并验收
|
|
228
|
+
|
|
229
|
+
**用户操作**:按交接说明检查功能,符合目标后明确“验收通过”;有差异就说明实际与预期。
|
|
230
|
+
|
|
231
|
+
**AI 处理**:汇总成果与遗留事项,记录你的实际验收决定。完整交付需有必要文档批准、批内及整体 review、独立验证和最终验收依据。
|
|
232
|
+
|
|
233
|
+
**输出产物**:`handoff.md` 提供成果位置、用法、验证结论和合并/部署状态。先前文档批准不替代最终验收,开发完成也不等于已部署。
|
|
234
|
+
|
|
235
|
+
<a id="guide-sessions"></a>
|
|
236
|
+
|
|
237
|
+
## 2. 会话与续接
|
|
238
|
+
|
|
239
|
+
<a id="2-会话进度与验收"></a>
|
|
240
|
+
<a id="21-在新会话中接续"></a>
|
|
241
|
+
<a id="23-会话划分建议"></a>
|
|
140
242
|
<a id="continue"></a>
|
|
141
243
|
<a id="continue-in-another-conversation"></a>
|
|
142
244
|
<a id="5-暂停后或换会话继续"></a>
|
|
143
245
|
<a id="6-暂停后或换会话继续"></a>
|
|
144
|
-
|
|
246
|
+
<a id="6-会话安排与继续工作"></a>
|
|
247
|
+
<a id="继续已有交付或切换会话"></a>
|
|
248
|
+
<a id="3-下次如何继续"></a>
|
|
249
|
+
<a id="安排新会话与交接"></a>
|
|
250
|
+
<a id="在新会话中接续"></a>
|
|
251
|
+
<a id="会话划分建议"></a>
|
|
252
|
+
<a id="guide-continue"></a>
|
|
253
|
+
<a id="21-换会话与接续"></a>
|
|
145
254
|
|
|
146
|
-
###
|
|
255
|
+
### 2.1 何时换会话
|
|
147
256
|
|
|
148
|
-
|
|
257
|
+
按 `status.md` 的建议在需求、技术与适用契约、用例、计划、实施批次、整体 review、验证批次之间换会话,也可继续当前会话;分组不改变逐份审核。
|
|
149
258
|
|
|
150
|
-
|
|
151
|
-
| --- | --- |
|
|
152
|
-
| 需求/Scope | 一个会话 |
|
|
153
|
-
| 技术文档、SQL、接口文档 | 共用一个会话 |
|
|
154
|
-
| 测试用例设计 | 一个会话 |
|
|
155
|
-
| 实施计划 | 一个会话 |
|
|
156
|
-
| 实施 | 每个实施批次一个会话,包含该批 Agent 评审 |
|
|
157
|
-
| 整体 review | 一个会话 |
|
|
158
|
-
| 测试执行 | 每个测试批次一个会话 |
|
|
259
|
+
新会话操作见[演示中的续接示例](#guide-session-example)。同一交付只保留一个写入会话;可信记录可直接定位,找不到或有多个候选才询问。交付语言沿用已保存设置。首次保存前就要切换时,携带未保存诉求、计划位置及未完成操作。
|
|
159
260
|
|
|
160
|
-
|
|
261
|
+
<a id="22-工作意外停止后继续"></a>
|
|
262
|
+
<a id="工作意外停止后继续"></a>
|
|
263
|
+
<a id="guide-recovery"></a>
|
|
264
|
+
<a id="32-中断重复启用或进度不一致"></a>
|
|
161
265
|
|
|
162
|
-
|
|
266
|
+
### 2.2 中断后恢复
|
|
163
267
|
|
|
164
|
-
|
|
268
|
+
提供原交付目录、中断时的操作和错误信息。AI 核对已保存状态、文件与未完成操作,保留身份及资料;状态已保存但进度页失败时只修复缺失视图。重复启用不重新初始化。
|
|
165
269
|
|
|
166
|
-
|
|
270
|
+
进度页手改内容先保留,冲突先协调;不要靠改进度页表达批准。工程搬迁后提供新位置,由 AI 核对身份再更新关联。
|
|
167
271
|
|
|
168
|
-
>
|
|
272
|
+
<a id="3-其他起点与工作安排"></a>
|
|
273
|
+
<a id="scenarios"></a>
|
|
274
|
+
<a id="5-其他起点与工作安排"></a>
|
|
275
|
+
<a id="guide-other"></a>
|
|
276
|
+
<a id="2-其他使用说明"></a>
|
|
277
|
+
<a id="guide-inputs"></a>
|
|
169
278
|
|
|
170
|
-
|
|
279
|
+
## 3. 需求输入与变更
|
|
171
280
|
|
|
172
|
-
|
|
281
|
+
<a id="31-已有-prd原型或其他资料"></a>
|
|
282
|
+
<a id="已有-prd原型或其他资料"></a>
|
|
283
|
+
<a id="guide-adoption"></a>
|
|
284
|
+
<a id="23-已有-prd原型或其他资料"></a>
|
|
285
|
+
<a id="33-将当前讨论转为交付"></a>
|
|
286
|
+
<a id="将当前讨论转为交付"></a>
|
|
287
|
+
<a id="guide-discussion"></a>
|
|
288
|
+
<a id="25-从已有讨论转入"></a>
|
|
173
289
|
|
|
174
|
-
|
|
290
|
+
### 3.1 已有资料或讨论
|
|
291
|
+
|
|
292
|
+
提供 PRD、原型或截图的位置、版本和本次使用范围,AI 按[确认需求](#guide-requirements)核对。若要直接维护已有 PRD,请明确说明;AI 核对本次目标和完成范围后送审,已有文件不等于已批准。
|
|
293
|
+
|
|
294
|
+
已有讨论可说:“使用 Aimship 继续刚才讨论的需求。”AI 整理可见的诉求、决定和待确认问题;看不到的历史请补充,建议不算批准。
|
|
295
|
+
|
|
296
|
+
<a id="16-已批准的需求发生变化"></a>
|
|
297
|
+
<a id="5-推进中需求发生变化"></a>
|
|
298
|
+
<a id="changes"></a>
|
|
299
|
+
<a id="review-verify-and-change"></a>
|
|
300
|
+
<a id="4-推进中需求发生变化"></a>
|
|
301
|
+
<a id="已批准的需求发生变化"></a>
|
|
302
|
+
<a id="guide-changes"></a>
|
|
303
|
+
<a id="22-已批准内容需要变化"></a>
|
|
175
304
|
|
|
176
|
-
###
|
|
305
|
+
### 3.2 修改已批准内容
|
|
177
306
|
|
|
178
|
-
|
|
307
|
+
说明改什么、为什么改、哪些保持不变;自行改过文档时指出文件。AI 在 `change-log.md` 记录重要变化,将受影响文档重新送审,相关工作待确认后继续。未受影响的工作、旧批准和测试历史保留。
|
|
179
308
|
|
|
180
|
-
|
|
309
|
+
新诉求写入需求文档和变更记录,不覆盖 `source/request.md`。原始诉求被误改时,从可靠原件恢复;找不到就暂停核对。错字或排版无需全部重审。交付后的小修可继续原交付;新目标或大幅重设计另建交付,并注明与原交付的关系。
|
|
181
310
|
|
|
182
|
-
|
|
311
|
+
<a id="guide-limits"></a>
|
|
312
|
+
<a id="27-只做到部分目标"></a>
|
|
183
313
|
|
|
184
|
-
|
|
314
|
+
### 3.3 只完成部分目标
|
|
185
315
|
|
|
316
|
+
本次只需需求、设计或明确不做测试时,请说明。AI 记录做到哪里及未覆盖的部分,交接时标明阶段性成果,未测试不写成通过。“先看预览”不会改变原定目标。
|
|
317
|
+
|
|
318
|
+
独立调查才使用 `diagnosis.md`;普通调试不增加调查阶段。
|
|
319
|
+
|
|
320
|
+
<a id="guide-projects"></a>
|
|
321
|
+
|
|
322
|
+
## 4. 代码与多需求管理
|
|
323
|
+
|
|
324
|
+
<a id="32-修改现有功能修复缺陷或重构"></a>
|
|
325
|
+
<a id="34-需求开始后再关联代码"></a>
|
|
326
|
+
<a id="修改现有功能修复缺陷或重构"></a>
|
|
327
|
+
<a id="需求开始后再关联代码"></a>
|
|
328
|
+
<a id="guide-code"></a>
|
|
329
|
+
<a id="24-修改已有代码或稍后关联代码"></a>
|
|
330
|
+
|
|
331
|
+
### 4.1 关联代码、修复或重构
|
|
332
|
+
|
|
333
|
+
提供代码目录,例如:“代码在「工程目录」,继续当前交付。”AI 沿用原交付目录和审核记录,需要了解现有功能时可先只读查看;实际修改仍按约定范围进行。新发现影响已批准内容时重新送审。远端地址不会触发自动克隆或搬迁。
|
|
334
|
+
|
|
335
|
+
修复缺陷时,提供预期表现、实际问题、复现步骤或日志。重构时,说明改善目标和必须保持不变的功能行为。
|
|
336
|
+
|
|
337
|
+
<a id="35-同时推进多个需求"></a>
|
|
338
|
+
<a id="7-同时推进多个需求"></a>
|
|
186
339
|
<a id="parallel"></a>
|
|
187
340
|
<a id="work-on-two-requests-at-once"></a>
|
|
188
341
|
<a id="6-同时推进多个需求"></a>
|
|
189
|
-
|
|
342
|
+
<a id="同时推进多个需求"></a>
|
|
343
|
+
<a id="guide-parallel"></a>
|
|
344
|
+
<a id="26-同时处理多个需求"></a>
|
|
190
345
|
|
|
191
|
-
|
|
346
|
+
### 4.2 同时处理多个需求
|
|
192
347
|
|
|
193
|
-
|
|
348
|
+
每个需求使用独立交付目录,并说明共用的代码、接口、数据库或环境。可以同时分析;修改同一份代码时安排先后,或使用独立工作目录并安排合并。
|
|
194
349
|
|
|
195
|
-
|
|
350
|
+
AI 只能核对已知且可访问的交付,不会自动锁定或调度其他会话。请说明其他正在进行的修改,各自完成后仍需检查合并结果。
|
|
196
351
|
|
|
197
|
-
<a id="
|
|
198
|
-
<a id="
|
|
199
|
-
<a id="
|
|
200
|
-
|
|
352
|
+
<a id="4-常见问题与参考"></a>
|
|
353
|
+
<a id="troubleshoot"></a>
|
|
354
|
+
<a id="8-使用中遇到问题"></a>
|
|
355
|
+
<a id="9-使用中遇到问题"></a>
|
|
356
|
+
<a id="6-常见问题与参考"></a>
|
|
357
|
+
<a id="guide-troubleshoot"></a>
|
|
358
|
+
<a id="3-权限恢复与版本"></a>
|
|
359
|
+
<a id="guide-maintenance"></a>
|
|
201
360
|
|
|
202
|
-
|
|
361
|
+
## 5. 问题处理与维护
|
|
203
362
|
|
|
204
|
-
|
|
363
|
+
<a id="41-常见问题"></a>
|
|
364
|
+
<a id="guide-access"></a>
|
|
365
|
+
<a id="31-工作位置与访问权限"></a>
|
|
205
366
|
|
|
206
|
-
|
|
367
|
+
### 5.1 目录无法访问
|
|
207
368
|
|
|
208
|
-
|
|
369
|
+
按 AI 报出的实际路径,在 AI 工具中添加原交付目录或授予所需权限。若目录尚未创建,按工具支持的方式授权所需父目录,再继续初始化。不要复制交付或换个位置另建一套。
|
|
209
370
|
|
|
210
|
-
|
|
211
|
-
<a id="8-使用中遇到问题"></a>
|
|
212
|
-
## 9. 使用中遇到问题
|
|
371
|
+
能读文件不代表能保存;AI 应根据实际读写结果报告是否成功。Aimship 不会替你操作权限界面。尚未保存的诉求请保留在当前会话,恢复访问后先核对已有文件,再继续;安装不会自动创建交付目录或授予访问权限。
|
|
213
372
|
|
|
214
|
-
|
|
215
|
-
|
|
216
|
-
|
|
217
|
-
|
|
218
|
-
|
|
219
|
-
|
|
220
|
-
| 找不到 Aimship、安装或版本异常 | 查看 README 的[安装与升级问题](../README.zh-CN.md#installation-troubleshooting) |
|
|
373
|
+
<a id="43-ai-工具集成说明"></a>
|
|
374
|
+
<a id="ai-工具集成说明"></a>
|
|
375
|
+
<a id="guide-hosts-notes"></a>
|
|
376
|
+
<a id="34-找不到入口或宿主行为不同"></a>
|
|
377
|
+
<a id="34-找不到入口或-ai-工具行为不同"></a>
|
|
378
|
+
<a id="guide-tools"></a>
|
|
221
379
|
|
|
222
|
-
|
|
380
|
+
### 5.2 找不到 Aimship 入口
|
|
223
381
|
|
|
224
|
-
|
|
382
|
+
先按 README 检查安装状态,再尝试新开会话或刷新 AI 工具的 Skill 列表,明确选择 Aimship。具体入口以所用 AI 工具的版本和支持方式为准;安装检查通过不代表它已经加载 Skill。
|
|
225
383
|
|
|
226
|
-
|
|
227
|
-
|
|
228
|
-
|
|
384
|
+
出现重复入口时,先核对来源和版本,保留已有定制内容。Codex 与 Cursor 共用安装入口,不要直接删除重复项。真实 AI 工具的发现、权限和跨工具续接尚未完整验证;可参考 [Cursor 文档](https://cursor.com/docs/skills)和 [Codex Skill 位置说明](https://learn.chatgpt.com/docs/build-skills)。
|
|
385
|
+
|
|
386
|
+
<a id="42-升级-aimship-后继续已有交付"></a>
|
|
387
|
+
<a id="升级-aimship-后继续已有交付"></a>
|
|
388
|
+
<a id="guide-upgrade"></a>
|
|
389
|
+
<a id="33-升级后继续已有交付"></a>
|
|
229
390
|
|
|
391
|
+
### 5.3 升级后继续
|
|
392
|
+
|
|
393
|
+
升级前保存当前工作,再按 README [升级](../README.zh-CN.md#update)。升级后重新启用 Aimship,核对实际绑定版本和交付状态;安装本身不会更新交付记录。
|
|
394
|
+
|
|
395
|
+
使用普通 Markdown 和可搜索编号记录交付。规则更新前核对影响,保留实际审批和测试记录,不补造结果。
|
|
396
|
+
|
|
397
|
+
<a id="45-安装与维护参考"></a>
|
|
398
|
+
<a id="安装与维护参考"></a>
|
|
230
399
|
<a id="update"></a>
|
|
231
400
|
<a id="update-or-stop-using-aimship"></a>
|
|
232
|
-
软件升级、添加 AI 工具和版本/安装状态查询见 [README](../README.zh-CN.md#update)。
|
|
233
|
-
|
|
234
401
|
<a id="uninstall"></a>
|
|
235
|
-
|
|
402
|
+
<a id="guide-references"></a>
|
|
403
|
+
<a id="35-安装维护与反馈"></a>
|
|
236
404
|
|
|
237
|
-
|
|
238
|
-
<a id="sql变更和进度"></a>
|
|
239
|
-
## 附录:SQL 与工程版本
|
|
405
|
+
### 5.4 安装维护与反馈
|
|
240
406
|
|
|
241
|
-
|
|
407
|
+
安装、升级、添加 AI 工具、版本与健康查询见 [README](../README.zh-CN.md#update),移除见[卸载说明](../README.zh-CN.md#uninstall)。健康查询只检查安装文件和配置,不会修复交付文档;安装中断或文件缺失时,按 README 对应问题处理,不盲目重装。
|
|
242
408
|
|
|
243
|
-
|
|
409
|
+
反馈时提供版本、操作、预期与实际结果,以及最少的复现步骤。隐去凭据、个人路径和业务数据后提交 [Issue](https://github.com/clsx/aimship/issues)。开发见[贡献指南](../CONTRIBUTING.md),工具协议见 [CLI 文档](cli.md)。
|