Back to Details

project-sync

Compare original and translation side by side

🇺🇸

Original

English
🇨🇳

Translation

Chinese

Project Sync Workflow

项目同步工作流

Use this workflow when you have new experiment results in the code repo or a code worktree and want to record them in the paper's 
daily_experiments.tex
.
This is a manual, human-triggered workflow — run it whenever you want to checkpoint results into the paper.
Pair this skill with 
research-project-memory
when the logged result should update evidence, claims, risks, actions, or paper status.
当你在代码仓库或代码工作树中有新的实验结果，并希望将其记录到论文的
daily_experiments.tex
文件中时，可以使用此工作流。
这是一个手动触发、由人启动的工作流——每当你想要将结果checkpoint到论文中时即可运行。
如果记录的结果需要更新证据、声明、风险、行动或论文状态，请将此技能与
research-project-memory
配合使用。

Step 1 — Locate the Project

步骤1 — 定位项目

// turbo Auto-detect the project structure. Run:
bash
undefined
// turbo 自动检测项目结构。运行以下命令：
bash
undefined

Find the git root of the current repo

查找当前仓库的git根目录

git rev-parse --show-toplevel 2>/dev/null
git rev-parse --show-toplevel 2>/dev/null

Check if we're in code/ or paper/ and find sibling

检查当前是否处于code/或paper/目录，并查找同级目录

ls "$(git rev-parse --show-toplevel)/../"

Determine:
- `$CODE_ROOT` - the code repo root or active code worktree root
- `$PAPER_ROOT` - the paper repo root
- `$PROJECT_ROOT` - the project control root, if present

In a project-init project, `paper/` and `code/` are component repos under the project control root, and code worktrees usually live under `code-worktrees/`. If the paper repo cannot be inferred, ask the user:
> "Where is the paper repo? Please provide its path."

---
ls "$(git rev-parse --show-toplevel)/../"

确定以下路径：
- `$CODE_ROOT` - 代码仓库根目录或活跃的代码工作树根目录
- `$PAPER_ROOT` - 论文仓库根目录
- `$PROJECT_ROOT` - 项目控制根目录（如果存在）

在初始化的项目中，`paper/`和`code/`是项目控制根目录下的组件仓库，代码工作树通常位于`code-worktrees/`目录下。如果无法推断论文仓库的位置，请询问用户：
> "论文仓库在哪里？请提供其路径。"

---

Step 2 — Gather New Results

步骤2 — 收集新结果

Ask the user in a single message:
  1. Date: What date are these experiments? (default: today's date, YYYY-MM-DD)
  2. Short title: A brief label for this experiment batch (e.g. "Baseline on CIFAR-10", "Ablation: remove attention layer")
  3. Setup: What method variant / config / dataset was used?
  4. Results: What are the key numbers? (paste metrics, accuracy, loss, etc.)
  5. Observation: What do the results mean? What worked, what didn't?
  6. Next: What follow-up experiment is planned?
Optionally, also check if there are existing result files to pull from:
bash
undefined
在一条消息中询问用户以下内容：
  1. 日期：这些实验的日期是什么？（默认：今日日期，格式为YYYY-MM-DD）
  2. 简短标题：此批次实验的简短标签（例如："CIFAR-10 基准实验"、"消融实验：移除注意力层"）
  3. 实验设置：使用了哪种方法变体/配置/数据集？
  4. 结果：关键数据是什么？（粘贴指标、准确率、损失值等）
  5. 观察结论：这些结果意味着什么？哪些有效，哪些无效？
  6. 后续计划：接下来计划进行什么实验？
可选操作：检查是否有可提取的现有结果文件：
bash
undefined

Stable code-side evidence

代码端稳定证据

find "$CODE_ROOT/docs/results" "$CODE_ROOT/docs/reports" "$CODE_ROOT/docs/runs" -maxdepth 2 -type f 2>/dev/null | sort | tail -20
find "$CODE_ROOT/docs/results" "$CODE_ROOT/docs/reports" "$CODE_ROOT/docs/runs" -maxdepth 2 -type f 2>/dev/null | sort | tail -20

Raw or ignored outputs, if present

原始或忽略的输出（如果存在）

find "$CODE_ROOT/outputs" "$CODE_ROOT/logs" "$CODE_ROOT/checkpoints" -maxdepth 2 -type f 2>/dev/null | sort | tail -20

If relevant result summaries or reports exist, read them and pre-fill the answers for the user to confirm. Treat raw logs as supporting material, not paper-facing evidence, unless the user confirms the numbers.

---
find "$CODE_ROOT/outputs" "$CODE_ROOT/logs" "$CODE_ROOT/checkpoints" -maxdepth 2 -type f 2>/dev/null | sort | tail -20

如果存在相关的结果摘要或报告，读取并预填答案供用户确认。除非用户确认数据，否则将原始日志视为辅助材料，而非论文可用证据。

---

Step 3 — Preview the Entry

步骤3 — 预览日志条目

Compose and display the LaTeX entry for the user to review:
latex
\subsection*{<DATE> — <SHORT TITLE>}
\textbf{Setup:} <setup>\\
\textbf{Result:} <results>\\
\textbf{Observation:} <observation>\\
\textbf{Next:} <next>
Ask: "Does this look correct? Should I add it to the paper?"
Wait for confirmation.
撰写并展示LaTeX条目供用户审核：
latex
\subsection*{<DATE> — <SHORT TITLE>}
\textbf{Setup:} <setup>\\
\textbf{Result:} <results>\\
\textbf{Observation:} <observation>\\
\textbf{Next:} <next>
询问："这个条目看起来正确吗？是否要添加到论文中？"
等待用户确认。

Step 4 — Insert into daily_experiments.tex

步骤4 — 插入到daily_experiments.tex文件

// turbo Read the current contents of 
$PAPER_ROOT/sections/daily_experiments.tex
.
Insert the new entry at the top (below the comment header), so the log is in reverse chronological order (newest first).
After inserting, show the user the updated top of the file to confirm it looks right.
// turbo 读取
$PAPER_ROOT/sections/daily_experiments.tex
的当前内容。
将新条目插入到顶部（注释标题下方），使日志按逆 chronological 顺序排列（最新的在前）。
插入后，向用户展示文件更新后的顶部内容以确认无误。

Step 5 — Commit to Paper Repo (optional)

步骤5 — 提交到论文仓库（可选）

Ask: "要把这条实验记录提交到 paper repo 的 Git 吗？(Y/n)"
If yes:
bash
git -C "$PAPER_ROOT" add sections/daily_experiments.tex
git -C "$PAPER_ROOT" commit -m "exp: add <DATE> — <SHORT TITLE>"
If no, inform the user the file is saved and can be committed later.
询问："要把这条实验记录提交到 paper repo 的 Git 吗？(Y/n)"
如果用户回答是：
bash
git -C "$PAPER_ROOT" add sections/daily_experiments.tex
git -C "$PAPER_ROOT" commit -m "exp: add <DATE> — <SHORT TITLE>"
如果用户回答否，告知用户文件已保存，可稍后提交。

Step 6 — Confirm

步骤6 — 确认完成

Report:
Experiment logged:
  Date:   <DATE>
  Title:  <SHORT TITLE>
  File:   <PAPER_ROOT>/sections/daily_experiments.tex

To view all logged experiments:
  cat <PAPER_ROOT>/sections/daily_experiments.tex
报告：
实验已记录：
  日期：   <DATE>
  标题：  <SHORT TITLE>
  文件：   <PAPER_ROOT>/sections/daily_experiments.tex

查看所有已记录的实验：
  cat <PAPER_ROOT>/sections/daily_experiments.tex

Step 7 — Update Project Memory When Present

步骤7 — 若存在项目记忆则更新

If the parent project has 
memory/
, update:
  • memory/evidence-board.md
    : add the logged result as an 
    EVD-###
    or link it to an existing 
    EXP-###
  • memory/claim-board.md
    : mark affected claims as supported, weakened, or still unsupported
  • memory/risk-board.md
    : add or close risks exposed by the result
  • memory/action-board.md
    : add the next experiment/report/writing action from the log entry
  • paper/.agent/paper-status.md
    : note that 
    sections/daily_experiments.tex
    now contains the result
  • code/.agent/
    or 
    <code-worktree>/.agent/worktree-status.md
    : mark that the result was promoted to paper-facing evidence
Treat the daily experiment log as evidence only if the numbers are source-linked or user-confirmed. Otherwise mark certainty as 
user-stated
or 
needs-verification
.
如果父项目包含
memory/
目录，更新以下内容：
  • memory/evidence-board.md
    : 将记录的结果添加为
    EVD-###
    ，或链接到现有的
    EXP-###
  • memory/claim-board.md
    : 将受影响的声明标记为已支持、已削弱或仍未支持
  • memory/risk-board.md
    : 添加或关闭结果揭示的风险
  • memory/action-board.md
    : 从日志条目中添加下一个实验/报告/写作行动
  • paper/.agent/paper-status.md
    : 记录
    sections/daily_experiments.tex
    现在包含该结果
  • code/.agent/
    或
    <code-worktree>/.agent/worktree-status.md
    : 标记该结果已转化为论文可用证据
仅当数据有来源链接或用户确认时，才将每日实验日志视为证据。否则将确定性标记为
user-stated
或
needs-verification
。