alignfirst

Compare original and translation side by side

🇺🇸

Original

English

🇨🇳

Chinese

Choose the appropriate protocol based on the task:

Technical Specification (spec, or alspec): Read spec-protocol.md to write a technical specification
Implementation Plans (plan, or alplan): Read plan-protocol.md to create implementation plans from a spec
Align-and-Do Protocol (AAD): Read aad-protocol.md for smaller tasks without formal spec/plans
Description (aldescription): Read description-protocol.md to write a description summarizing implemented work

根据任务选择合适的协议：

TASK_DIR is the directory where work files related to a task are stored. Usually, we use TASK_DIR =

.plans/{TICKET_ID}/

(a sub-directory of the

.plans

folder). If no ticket ID is known, ask the user for it.

TASK_DIR 是存储与任务相关的工作文件的目录。通常我们设置 TASK_DIR =

.plans/{TICKET_ID}/

（

.plans

文件夹下的子目录）。如果不知道工单 ID，向用户询问。

Format:

{CYCLE_LETTER}{FILE_NUMBER}-{FILE_TYPE}.md

Common file types:

Example structure:

text

.plans/
├── 123/
│   ├── A1-spec.md
│   ├── A2-plan.md
│   └── A3-AAD.summary.md
│   └── B1-spec.md

格式：

{CYCLE_LETTER}{FILE_NUMBER}-{FILE_TYPE}.md

常见文件类型：

示例结构：

text

.plans/
├── 123/
│   ├── A1-spec.md
│   ├── A2-plan.md
│   └── A3-AAD.summary.md
│   └── B1-spec.md

TICKET_ID is a unique identifier for the task, often an issue or ticket number.
Cycles are identified by a CYCLE_LETTER (A, B, C...). The user decides when to start a new one.
In a cycle, determine the next FILE_NUMBER from existing file names. Every new file must have a bumped file number.
Do not bother the user with CYCLE_LETTER or FILE_NUMBER. They are for internal organization. It's up to you to list the files and determine the last CYCLE_LETTER and FILE_NUMBER. Start CYCLE_LETTER with
```
A
```
if there is no existing cycle, and FILE_NUMBER with
```
1
```
. So you just need to ask for a ticket ID if you don't have one.
When the user requests a new cycle: bump CYCLE_LETTER and reset FILE_NUMBER.
There is no strict sequence of file types in the workflow. Available file types are also flexible; if you need a new one, just create it.