superlab 0.1.7 → 0.1.8
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/README.md +65 -17
- package/README.zh-CN.md +64 -15
- package/bin/superlab.cjs +232 -1
- package/lib/context.cjs +337 -0
- package/lib/i18n.cjs +673 -41
- package/lib/install.cjs +249 -51
- package/package-assets/claude/commands/lab/framing.md +11 -0
- package/package-assets/claude/commands/lab/idea.md +2 -1
- package/package-assets/claude/commands/lab/iterate.md +2 -1
- package/package-assets/claude/commands/lab/report.md +2 -1
- package/package-assets/claude/commands/lab/review.md +2 -1
- package/package-assets/claude/commands/lab/run.md +2 -1
- package/package-assets/claude/commands/lab/spec.md +2 -1
- package/package-assets/claude/commands/lab/write.md +2 -1
- package/package-assets/codex/prompts/lab-framing.md +9 -0
- package/package-assets/codex/prompts/lab-idea.md +2 -1
- package/package-assets/codex/prompts/lab-iterate.md +2 -1
- package/package-assets/codex/prompts/lab-report.md +2 -1
- package/package-assets/codex/prompts/lab-review.md +2 -1
- package/package-assets/codex/prompts/lab-run.md +2 -1
- package/package-assets/codex/prompts/lab-spec.md +2 -1
- package/package-assets/codex/prompts/lab-write.md +2 -1
- package/package-assets/shared/{templates → lab/.managed/templates}/design.md +3 -3
- package/package-assets/shared/lab/.managed/templates/framing.md +66 -0
- package/package-assets/shared/{templates → lab/.managed/templates}/paper-plan.md +1 -0
- package/package-assets/shared/{templates → lab/.managed/templates}/proposal.md +1 -1
- package/package-assets/shared/{templates → lab/.managed/templates}/spec.md +2 -2
- package/package-assets/shared/{templates → lab/.managed/templates}/tasks.md +2 -2
- package/package-assets/shared/{templates → lab/.managed/templates}/write-iteration.md +1 -0
- package/package-assets/shared/lab/changes/README.md +10 -0
- package/package-assets/shared/lab/config/workflow.json +6 -0
- package/package-assets/shared/lab/context/next-action.md +19 -0
- package/package-assets/shared/lab/context/session-brief.md +30 -0
- package/package-assets/shared/lab/context/summary.md +21 -0
- package/package-assets/shared/lab/context/terminology-lock.md +27 -0
- package/package-assets/shared/lab/system/core.md +41 -0
- package/package-assets/shared/skills/lab/SKILL.md +54 -37
- package/package-assets/shared/skills/lab/references/paper-writing/abstract.md +2 -17
- package/package-assets/shared/skills/lab/references/paper-writing/introduction.md +3 -63
- package/package-assets/shared/skills/lab/references/paper-writing/method.md +4 -34
- package/package-assets/shared/skills/lab/references/workflow.md +4 -4
- package/package-assets/shared/skills/lab/stages/framing.md +70 -0
- package/package-assets/shared/skills/lab/stages/idea.md +5 -5
- package/package-assets/shared/skills/lab/stages/iterate.md +8 -8
- package/package-assets/shared/skills/lab/stages/report.md +7 -6
- package/package-assets/shared/skills/lab/stages/review.md +6 -5
- package/package-assets/shared/skills/lab/stages/run.md +4 -4
- package/package-assets/shared/skills/lab/stages/spec.md +11 -11
- package/package-assets/shared/skills/lab/stages/write.md +14 -10
- package/package.json +1 -1
- package/package-assets/shared/changes/README.md +0 -10
- package/package-assets/shared/config/workflow.json +0 -5
- package/package-assets/shared/examples/minimal-uplift-workflow.md +0 -73
- /package/package-assets/shared/{scripts → lab/.managed/scripts}/eval_report.py +0 -0
- /package/package-assets/shared/{scripts → lab/.managed/scripts}/register_run.py +0 -0
- /package/package-assets/shared/{scripts → lab/.managed/scripts}/summarize_iterations.py +0 -0
- /package/package-assets/shared/{scripts → lab/.managed/scripts}/validate_results.py +0 -0
- /package/package-assets/shared/{templates → lab/.managed/templates}/final-report.md +0 -0
- /package/package-assets/shared/{templates → lab/.managed/templates}/idea.md +0 -0
- /package/package-assets/shared/{templates → lab/.managed/templates}/iteration-report.md +0 -0
- /package/package-assets/shared/{templates → lab/.managed/templates}/paper-section.md +0 -0
- /package/package-assets/shared/{templates → lab/.managed/templates}/paper-section.tex +0 -0
- /package/package-assets/shared/{templates → lab/.managed/templates}/paper.tex +0 -0
- /package/package-assets/shared/{templates → lab/.managed/templates}/review-checklist.md +0 -0
- /package/package-assets/shared/{context → lab/context}/decisions.md +0 -0
- /package/package-assets/shared/{context → lab/context}/evidence-index.md +0 -0
- /package/package-assets/shared/{context → lab/context}/mission.md +0 -0
- /package/package-assets/shared/{context → lab/context}/open-questions.md +0 -0
- /package/package-assets/shared/{context → lab/context}/state.md +0 -0
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
## Lab Change
|
|
4
4
|
|
|
5
5
|
- Change id:
|
|
6
|
-
- Target path: `.
|
|
6
|
+
- Target path: `.lab/changes/<change-id>/spec.md`
|
|
7
7
|
|
|
8
8
|
## Requirements
|
|
9
9
|
|
|
@@ -15,7 +15,7 @@
|
|
|
15
15
|
## Acceptance
|
|
16
16
|
|
|
17
17
|
- Idea artifact written
|
|
18
|
-
- Lab change artifacts written in `.
|
|
18
|
+
- Lab change artifacts written in `.lab/changes/<change-id>/`
|
|
19
19
|
- Validation run executed
|
|
20
20
|
- Iteration reports generated
|
|
21
21
|
- Final report generated
|
|
@@ -1,9 +1,9 @@
|
|
|
1
1
|
# Tasks
|
|
2
2
|
|
|
3
3
|
- [ ] Identify the approved lab change id.
|
|
4
|
-
- [ ] Create `.
|
|
4
|
+
- [ ] Create `.lab/changes/<change-id>/`.
|
|
5
5
|
- [ ] Write the idea artifact.
|
|
6
|
-
- [ ] Convert the idea into `.
|
|
6
|
+
- [ ] Convert the idea into `.lab/changes/<change-id>/proposal.md`, `.lab/changes/<change-id>/design.md`, `.lab/changes/<change-id>/spec.md`, and `.lab/changes/<change-id>/tasks.md`.
|
|
7
7
|
- [ ] Run the first validation experiment.
|
|
8
8
|
- [ ] Normalize and validate the evaluation summary.
|
|
9
9
|
- [ ] Execute bounded iteration rounds.
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
# `.lab/changes`
|
|
2
|
+
|
|
3
|
+
Each approved `/lab:spec` change lives in one directory:
|
|
4
|
+
|
|
5
|
+
- `.lab/changes/<change-id>/proposal.md`
|
|
6
|
+
- `.lab/changes/<change-id>/design.md`
|
|
7
|
+
- `.lab/changes/<change-id>/spec.md`
|
|
8
|
+
- `.lab/changes/<change-id>/tasks.md`
|
|
9
|
+
|
|
10
|
+
This keeps spec artifacts grouped under `lab` instead of depending on external directory conventions.
|
|
@@ -0,0 +1,30 @@
|
|
|
1
|
+
# Session Brief
|
|
2
|
+
|
|
3
|
+
## Active Stage
|
|
4
|
+
|
|
5
|
+
- Stage:
|
|
6
|
+
|
|
7
|
+
## Mission
|
|
8
|
+
|
|
9
|
+
One sentence describing the active research mission.
|
|
10
|
+
|
|
11
|
+
## Best Current Path
|
|
12
|
+
|
|
13
|
+
- Approved direction:
|
|
14
|
+
- Why this is the active path:
|
|
15
|
+
|
|
16
|
+
## Main Risk
|
|
17
|
+
|
|
18
|
+
- Risk:
|
|
19
|
+
- Evidence gap:
|
|
20
|
+
|
|
21
|
+
## Read First
|
|
22
|
+
|
|
23
|
+
1. `.lab/context/mission.md`
|
|
24
|
+
2. `.lab/context/state.md`
|
|
25
|
+
3. `.lab/context/evidence-index.md`
|
|
26
|
+
|
|
27
|
+
## Do Not Change Silently
|
|
28
|
+
|
|
29
|
+
- Frozen boundary:
|
|
30
|
+
- Approval gate:
|
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
# Research Summary
|
|
2
|
+
|
|
3
|
+
## Current Direction
|
|
4
|
+
|
|
5
|
+
Summarize the current approved research direction in 5-10 lines.
|
|
6
|
+
|
|
7
|
+
## Strongest Evidence
|
|
8
|
+
|
|
9
|
+
- Claim:
|
|
10
|
+
- Supporting artifact:
|
|
11
|
+
- Caveat:
|
|
12
|
+
|
|
13
|
+
## Largest Risk
|
|
14
|
+
|
|
15
|
+
- Risk:
|
|
16
|
+
- Why it matters:
|
|
17
|
+
|
|
18
|
+
## Current Gap
|
|
19
|
+
|
|
20
|
+
- Missing evidence:
|
|
21
|
+
- Missing artifact:
|
|
@@ -0,0 +1,27 @@
|
|
|
1
|
+
# Approved Paper-Facing Terms
|
|
2
|
+
|
|
3
|
+
Record the currently approved naming and wording that later stages should reuse consistently.
|
|
4
|
+
|
|
5
|
+
## Approved Terms
|
|
6
|
+
|
|
7
|
+
- Paper title:
|
|
8
|
+
- Method name:
|
|
9
|
+
- Short name or acronym:
|
|
10
|
+
- Module names:
|
|
11
|
+
- Contribution bullets:
|
|
12
|
+
|
|
13
|
+
## Allowed Variants
|
|
14
|
+
|
|
15
|
+
- Acceptable shorter forms:
|
|
16
|
+
- Acceptable section-level aliases:
|
|
17
|
+
|
|
18
|
+
## Forbidden Terms
|
|
19
|
+
|
|
20
|
+
- Terms to avoid:
|
|
21
|
+
- Claims to avoid:
|
|
22
|
+
|
|
23
|
+
## Source Audit
|
|
24
|
+
|
|
25
|
+
- Recent academic papers reviewed:
|
|
26
|
+
- Primary sources reviewed:
|
|
27
|
+
- Why the approved wording is acceptable:
|
|
@@ -0,0 +1,41 @@
|
|
|
1
|
+
# Lab System Core
|
|
2
|
+
|
|
3
|
+
This project uses `.lab/` as the durable research workflow root.
|
|
4
|
+
|
|
5
|
+
## Default Read Order
|
|
6
|
+
|
|
7
|
+
For a new AI session, read these files in order:
|
|
8
|
+
|
|
9
|
+
1. `.lab/context/session-brief.md`
|
|
10
|
+
2. `.lab/context/mission.md`
|
|
11
|
+
3. `.lab/context/state.md`
|
|
12
|
+
4. `.lab/context/evidence-index.md`
|
|
13
|
+
|
|
14
|
+
Only expand to additional context when the brief points to it.
|
|
15
|
+
|
|
16
|
+
## Workflow Boundaries
|
|
17
|
+
|
|
18
|
+
- `.lab/context/` holds durable project research state.
|
|
19
|
+
- `.lab/changes/`, `.lab/iterations/`, and `.lab/writing/` hold workflow control artifacts.
|
|
20
|
+
- `.lab/.managed/` holds tool-managed templates and scripts.
|
|
21
|
+
- Deliverables belong under the configured `deliverables_root`, not inside `.lab/context/`.
|
|
22
|
+
|
|
23
|
+
## Task Routing
|
|
24
|
+
|
|
25
|
+
Use `/lab:*` only for research workflow tasks:
|
|
26
|
+
|
|
27
|
+
- idea development
|
|
28
|
+
- specification
|
|
29
|
+
- experiment execution
|
|
30
|
+
- bounded iteration
|
|
31
|
+
- reviewer-style critique
|
|
32
|
+
- final reporting
|
|
33
|
+
- paper drafting
|
|
34
|
+
|
|
35
|
+
Do not force `/lab:*` onto unrelated engineering tasks.
|
|
36
|
+
|
|
37
|
+
## State Discipline
|
|
38
|
+
|
|
39
|
+
- Treat `.lab/context/*` as durable project state.
|
|
40
|
+
- Do not silently overwrite context files.
|
|
41
|
+
- Keep sourced evidence separate from generated hypotheses.
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
---
|
|
2
2
|
name: lab
|
|
3
|
-
description: Strict research workflow for idea development, lab change specification, small-scale experiment execution, bounded iteration, reviewer-grade critique, final reporting, and paper-writing.
|
|
3
|
+
description: Strict research workflow for idea development, framing, lab change specification, small-scale experiment execution, bounded iteration, reviewer-grade critique, final reporting, and paper-writing.
|
|
4
4
|
---
|
|
5
5
|
|
|
6
6
|
# /lab Skill
|
|
@@ -9,16 +9,17 @@ Use this skill when the user invokes `/lab:*` or asks for the structured researc
|
|
|
9
9
|
|
|
10
10
|
## Global Rules
|
|
11
11
|
|
|
12
|
-
- Keep idea generation, specification, execution, review, and reporting as separate stages.
|
|
12
|
+
- Keep idea generation, framing, specification, execution, review, and reporting as separate stages.
|
|
13
13
|
- Keep paper writing separate from experiment execution and reporting.
|
|
14
|
+
- When the user explicitly invokes `/lab:<stage>`, execute that stage against the provided target instead of replying with a recommendation for another `/lab` stage.
|
|
14
15
|
- Start each stage with a concise user-facing summary before writing artifacts.
|
|
15
16
|
- After that summary, decide whether immediate artifact creation is useful; if yes, write the artifact and then report the output path plus next step.
|
|
16
17
|
- When a missing assumption would materially change the stage outcome, ask one clarifying question at a time.
|
|
17
18
|
- When there are multiple viable paths, present 2-3 approaches with trade-offs and a recommendation before converging.
|
|
18
19
|
- When a stage materially sets downstream direction, keep an explicit approval gate before proceeding.
|
|
19
20
|
- Write durable artifacts to disk instead of leaving key decisions only in chat.
|
|
20
|
-
- Use `.
|
|
21
|
-
- Use `.
|
|
21
|
+
- Use `.lab/config/workflow.json` as the global contract for workflow language, paper language, and paper format.
|
|
22
|
+
- Use `.lab/context/` as the shared project state for both Codex and Claude entrypoints.
|
|
22
23
|
- Workflow artifacts should follow the installed workflow language.
|
|
23
24
|
- Final paper output should default to LaTeX, and its manuscript language should be decided separately from the workflow language.
|
|
24
25
|
- Separate sourced facts from model-generated hypotheses.
|
|
@@ -29,7 +30,7 @@ Use this skill when the user invokes `/lab:*` or asks for the structured researc
|
|
|
29
30
|
### `/lab:idea`
|
|
30
31
|
|
|
31
32
|
- Search relevant literature, baselines, datasets, and evaluation metrics before proposing a plan.
|
|
32
|
-
- Read `.
|
|
33
|
+
- Read `.lab/context/mission.md` and `.lab/context/open-questions.md` before drafting.
|
|
33
34
|
- Ask one clarifying question at a time when critical ambiguity remains.
|
|
34
35
|
- State the problem, the failure case, and why the problem matters before proposing solutions.
|
|
35
36
|
- Classify the idea by contribution category and breakthrough level.
|
|
@@ -39,27 +40,41 @@ Use this skill when the user invokes `/lab:*` or asks for the structured researc
|
|
|
39
40
|
- Produce 2-3 candidate approaches with trade-offs before recommending one.
|
|
40
41
|
- Critique the idea before converging on it.
|
|
41
42
|
- Keep an explicit approval gate before `/lab:spec`.
|
|
42
|
-
- Write idea artifacts with the template in `.
|
|
43
|
-
- Update `.
|
|
43
|
+
- Write idea artifacts with the template in `.lab/.managed/templates/idea.md`.
|
|
44
|
+
- Update `.lab/context/mission.md`, `.lab/context/decisions.md`, and `.lab/context/open-questions.md` after convergence.
|
|
44
45
|
- Do not implement code in this stage.
|
|
45
46
|
|
|
47
|
+
### `/lab:framing`
|
|
48
|
+
|
|
49
|
+
- Use this stage for paper-facing naming and wording decisions, not for new experimental claims.
|
|
50
|
+
- Read `.lab/config/workflow.json`, `.lab/context/mission.md`, `.lab/context/decisions.md`, and `.lab/context/evidence-index.md` before drafting.
|
|
51
|
+
- Audit method name, module names, paper title, and contribution bullets together as one framing pack.
|
|
52
|
+
- Distinguish canonical field terms from new labels; prefer canonical object names whenever possible.
|
|
53
|
+
- State whether each proposed term is standard, adapted, or newly coined.
|
|
54
|
+
- Reject names that hide the object being calibrated, estimated, ranked, or predicted.
|
|
55
|
+
- Avoid acronym-first naming and names that sound like implementation patches or marketing language.
|
|
56
|
+
- Produce 2-3 candidate framing packs with trade-offs before recommending one.
|
|
57
|
+
- Write the durable framing artifact with `.lab/.managed/templates/framing.md`.
|
|
58
|
+
- Update `.lab/writing/framing.md`, `.lab/context/decisions.md`, and `.lab/context/state.md` after convergence.
|
|
59
|
+
- Keep an explicit approval gate before `/lab:write`.
|
|
60
|
+
|
|
46
61
|
### `/lab:spec`
|
|
47
62
|
|
|
48
|
-
- Read `.
|
|
49
|
-
- Read `.
|
|
50
|
-
- Use `.
|
|
51
|
-
- Convert the approved idea into lab change artifacts using `.
|
|
52
|
-
- Update `.
|
|
63
|
+
- Read `.lab/config/workflow.json` before drafting the change.
|
|
64
|
+
- Read `.lab/context/mission.md`, `.lab/context/decisions.md`, and `.lab/context/state.md` before drafting the change.
|
|
65
|
+
- Use `.lab/changes/<change-id>/` as the canonical lab change directory.
|
|
66
|
+
- Convert the approved idea into lab change artifacts using `.lab/.managed/templates/proposal.md`, `.lab/.managed/templates/design.md`, `.lab/.managed/templates/spec.md`, and `.lab/.managed/templates/tasks.md`.
|
|
67
|
+
- Update `.lab/context/state.md` and `.lab/context/decisions.md` after freezing the spec.
|
|
53
68
|
- Do not skip task definition.
|
|
54
69
|
|
|
55
70
|
### `/lab:run`
|
|
56
71
|
|
|
57
72
|
- Start with the smallest meaningful experiment.
|
|
58
|
-
- Read `.
|
|
59
|
-
- Register the run with `.
|
|
60
|
-
- Normalize the result with `.
|
|
61
|
-
- Validate normalized output with `.
|
|
62
|
-
- Update `.
|
|
73
|
+
- Read `.lab/context/mission.md` and `.lab/context/state.md` before choosing the run.
|
|
74
|
+
- Register the run with `.lab/.managed/scripts/register_run.py`.
|
|
75
|
+
- Normalize the result with `.lab/.managed/scripts/eval_report.py`.
|
|
76
|
+
- Validate normalized output with `.lab/.managed/scripts/validate_results.py`.
|
|
77
|
+
- Update `.lab/context/state.md` and `.lab/context/evidence-index.md` after the run.
|
|
63
78
|
|
|
64
79
|
### `/lab:iterate`
|
|
65
80
|
|
|
@@ -73,40 +88,41 @@ Use this skill when the user invokes `/lab:*` or asks for the structured researc
|
|
|
73
88
|
- maximum iteration count
|
|
74
89
|
- Only change implementation hypotheses within the loop.
|
|
75
90
|
- Require a normalized evaluation report each round.
|
|
76
|
-
- Read `.
|
|
91
|
+
- Read `.lab/context/mission.md`, `.lab/context/state.md`, `.lab/context/decisions.md`, and `.lab/context/evidence-index.md` at the start of each round.
|
|
77
92
|
- Switch to diagnostic mode if risk increases for two consecutive rounds.
|
|
78
|
-
- Write round reports with `.
|
|
79
|
-
- Update `.
|
|
93
|
+
- Write round reports with `.lab/.managed/templates/iteration-report.md`.
|
|
94
|
+
- Update `.lab/context/state.md`, `.lab/context/decisions.md`, `.lab/context/evidence-index.md`, and `.lab/context/open-questions.md` each round as needed.
|
|
80
95
|
- Stop at threshold success or iteration cap, and record blockers plus next-best actions when the campaign ends without success.
|
|
81
96
|
|
|
82
97
|
### `/lab:review`
|
|
83
98
|
|
|
84
99
|
- Work in reviewer mode, not implementation mode.
|
|
85
|
-
- Read `.
|
|
100
|
+
- Read `.lab/context/mission.md`, `.lab/context/decisions.md`, and `.lab/context/evidence-index.md` before reviewing.
|
|
86
101
|
- Start with a concise summary of what is being reviewed and the top review question.
|
|
87
102
|
- Prioritize methodology, fairness, leakage, statistics, ablations, and claim discipline.
|
|
88
103
|
- Output findings first, then fatal flaws, then fix priority, then residual risks.
|
|
89
|
-
- Use `.
|
|
90
|
-
- Write durable review conclusions back to `.
|
|
104
|
+
- Use `.lab/.managed/templates/review-checklist.md`.
|
|
105
|
+
- Write durable review conclusions back to `.lab/context/state.md` or `.lab/context/open-questions.md` when they affect later stages.
|
|
91
106
|
|
|
92
107
|
### `/lab:report`
|
|
93
108
|
|
|
94
109
|
- Summarize all validated iteration summaries.
|
|
95
|
-
- Read `.
|
|
96
|
-
- Aggregate them with `.
|
|
97
|
-
- Write the final document with `.
|
|
110
|
+
- Read `.lab/context/mission.md`, `.lab/context/state.md`, `.lab/context/decisions.md`, and `.lab/context/evidence-index.md` before drafting.
|
|
111
|
+
- Aggregate them with `.lab/.managed/scripts/summarize_iterations.py`.
|
|
112
|
+
- Write the final document with `.lab/.managed/templates/final-report.md`.
|
|
98
113
|
- Keep failed attempts and limitations visible.
|
|
99
|
-
- Update `.
|
|
114
|
+
- Update `.lab/context/state.md` and `.lab/context/evidence-index.md` with report-level handoff notes.
|
|
100
115
|
|
|
101
116
|
### `/lab:write`
|
|
102
117
|
|
|
103
118
|
- Start only after `report` artifacts are stable enough to support paper claims.
|
|
104
|
-
-
|
|
105
|
-
- Read `.
|
|
119
|
+
- Start only after an approved framing artifact exists at `.lab/writing/framing.md`.
|
|
120
|
+
- Read `.lab/config/workflow.json` before drafting and enforce its `paper_language` and `paper_format`.
|
|
121
|
+
- Read `.lab/context/mission.md`, `.lab/context/decisions.md`, and `.lab/context/evidence-index.md` before drafting.
|
|
106
122
|
- Write one paper section or one explicit subproblem per round.
|
|
107
123
|
- Bind each claim to evidence from `report`, iteration reports, or normalized summaries.
|
|
108
|
-
- Write planning artifacts with `.
|
|
109
|
-
- Write final manuscript artifacts with `.
|
|
124
|
+
- Write planning artifacts with `.lab/.managed/templates/paper-plan.md`, `.lab/.managed/templates/paper-section.md`, and `.lab/.managed/templates/write-iteration.md`.
|
|
125
|
+
- Write final manuscript artifacts with `.lab/.managed/templates/paper.tex` and `.lab/.managed/templates/paper-section.tex`.
|
|
110
126
|
- Use the vendored paper-writing references under `skills/lab/references/paper-writing/`.
|
|
111
127
|
- Load only the current section guide, plus `paper-review.md` and `does-my-writing-flow-source.md`.
|
|
112
128
|
- Build a compact mini-outline before prose.
|
|
@@ -116,20 +132,21 @@ Use this skill when the user invokes `/lab:*` or asks for the structured researc
|
|
|
116
132
|
- Before finalizing a round, append and answer the five-dimension self-review checklist and revise unresolved items.
|
|
117
133
|
- Apply paper-writing discipline without changing experimental truth.
|
|
118
134
|
- If the evidence is insufficient, stop and route back to `review` or `iterate`.
|
|
119
|
-
- Update `.
|
|
135
|
+
- Update `.lab/context/state.md` and `.lab/context/evidence-index.md` when section-level claim status changes.
|
|
120
136
|
|
|
121
137
|
## Hard Gates
|
|
122
138
|
|
|
123
139
|
- No implementation before `/lab:spec`.
|
|
124
140
|
- No unconstrained iteration. Every `/lab:iterate` campaign must declare done criteria and `max_iterations`.
|
|
125
141
|
- No final report without validated normalized results.
|
|
126
|
-
- No paper-writing round without stable report artifacts, evidence links, and LaTeX manuscript output.
|
|
142
|
+
- No paper-writing round without stable report artifacts, an approved framing artifact, evidence links, and LaTeX manuscript output.
|
|
127
143
|
|
|
128
144
|
## References
|
|
129
145
|
|
|
130
146
|
- Workflow summary: `.codex/skills/lab/references/workflow.md` or `.claude/skills/lab/references/workflow.md`
|
|
131
147
|
- Brainstorming integration: `.codex/skills/lab/references/brainstorming-integration.md` or `.claude/skills/lab/references/brainstorming-integration.md`
|
|
132
148
|
- Idea stage guide: `.codex/skills/lab/stages/idea.md` or `.claude/skills/lab/stages/idea.md`
|
|
149
|
+
- Framing stage guide: `.codex/skills/lab/stages/framing.md` or `.claude/skills/lab/stages/framing.md`
|
|
133
150
|
- Spec stage guide: `.codex/skills/lab/stages/spec.md` or `.claude/skills/lab/stages/spec.md`
|
|
134
151
|
- Run stage guide: `.codex/skills/lab/stages/run.md` or `.claude/skills/lab/stages/run.md`
|
|
135
152
|
- Iterate stage guide: `.codex/skills/lab/stages/iterate.md` or `.claude/skills/lab/stages/iterate.md`
|
|
@@ -139,7 +156,7 @@ Use this skill when the user invokes `/lab:*` or asks for the structured researc
|
|
|
139
156
|
- Paper-writing integration: `.codex/skills/lab/references/paper-writing-integration.md` or `.claude/skills/lab/references/paper-writing-integration.md`
|
|
140
157
|
- Vendored paper-writing references: `.codex/skills/lab/references/paper-writing/{abstract,introduction,related-work,method,experiments,conclusion,paper-review,does-my-writing-flow-source}.md` or `.claude/skills/lab/references/paper-writing/{abstract,introduction,related-work,method,experiments,conclusion,paper-review,does-my-writing-flow-source}.md`
|
|
141
158
|
- Command adapters: the installed `/lab:*` command assets
|
|
142
|
-
- Shared workflow config: `.
|
|
143
|
-
- Shared project context: `.
|
|
144
|
-
- Templates: `.
|
|
145
|
-
- Scripts: `.
|
|
159
|
+
- Shared workflow config: `.lab/config/workflow.json`
|
|
160
|
+
- Shared project context: `.lab/context/{mission,state,decisions,evidence-index,open-questions}.md`
|
|
161
|
+
- Templates: `.lab/.managed/templates/`
|
|
162
|
+
- Scripts: `.lab/.managed/scripts/`
|
|
@@ -36,10 +36,6 @@ Introduce the technical challenge, then use one to two sentences to present the
|
|
|
36
36
|
3. The technical term must be easy to understand; readers should not feel a jump.
|
|
37
37
|
4. This ability is very important for writing a good abstract.
|
|
38
38
|
|
|
39
|
-
Version 1 local cite:
|
|
40
|
-
|
|
41
|
-
1. `references/examples/abstract/template-a.md`
|
|
42
|
-
|
|
43
39
|
## Version 2: Challenge -> Insight -> Contribution
|
|
44
40
|
|
|
45
41
|
Introduce the technical challenge, then use one to two sentences to present the insight for solving the challenge, and then one sentence to present the technical contribution that implements this insight.
|
|
@@ -61,10 +57,6 @@ Introduce the technical challenge, then use one to two sentences to present the
|
|
|
61
57
|
4. The technical term must be easy to understand; do not create a jump in reading.
|
|
62
58
|
5. This ability is very important for writing a good abstract.
|
|
63
59
|
|
|
64
|
-
Version 2 local cite:
|
|
65
|
-
|
|
66
|
-
1. `references/examples/abstract/template-b.md`
|
|
67
|
-
|
|
68
60
|
## Version 3: Multiple Contributions
|
|
69
61
|
|
|
70
62
|
Version 3: When there are multiple technical contributions, describe each contribution together with its technical advantage.
|
|
@@ -83,16 +75,9 @@ Version 3: When there are multiple technical contributions, describe each contri
|
|
|
83
75
|
1. When there are multiple technical contributions, describe each contribution together with its technical advantage.
|
|
84
76
|
2. The ability to express "contribution + advantage" in one sentence is very important for writing a good abstract.
|
|
85
77
|
|
|
86
|
-
|
|
87
|
-
|
|
88
|
-
1. `references/examples/abstract/template-c.md`
|
|
89
|
-
|
|
90
|
-
## Example Bank
|
|
78
|
+
## Usage Note
|
|
91
79
|
|
|
92
|
-
|
|
93
|
-
2. `references/examples/abstract/template-a.md`
|
|
94
|
-
3. `references/examples/abstract/template-b.md`
|
|
95
|
-
4. `references/examples/abstract/template-c.md`
|
|
80
|
+
This vendored guide is intentionally self-contained. The original example-bank files are not bundled in `superlab`, so use the structures and checklists in this document directly rather than chasing external example paths.
|
|
96
81
|
|
|
97
82
|
## Abstract Quality Checklist
|
|
98
83
|
|
|
@@ -91,10 +91,6 @@ Sentence skeleton:
|
|
|
91
91
|
1. `[xxx task] targets at recovering/reconstructing/estimating [xxx output] from [xxx input].`
|
|
92
92
|
2. `[xxx task] has a variety of applications such as [xxx], [xxx], and [xxx].`
|
|
93
93
|
|
|
94
|
-
Local cite:
|
|
95
|
-
|
|
96
|
-
1. `references/examples/introduction/version-1-task-then-application.md`
|
|
97
|
-
|
|
98
94
|
### Version 2
|
|
99
95
|
|
|
100
96
|
`Version 2: If the task is already familiar to most readers, introduce applications directly.`
|
|
@@ -109,10 +105,6 @@ Sentence skeleton:
|
|
|
109
105
|
|
|
110
106
|
1. `[xxx task] has a variety of applications such as [xxx], [xxx], and [xxx].`
|
|
111
107
|
|
|
112
|
-
Local cite:
|
|
113
|
-
|
|
114
|
-
1. `references/examples/introduction/version-2-application-first.md`
|
|
115
|
-
|
|
116
108
|
### Version 3
|
|
117
109
|
|
|
118
110
|
`Version 3: Introduce applications of the general task first, then introduce the specific task setting. (Personally recommended when the setting is relatively new.)`
|
|
@@ -128,10 +120,6 @@ Sentence skeleton:
|
|
|
128
120
|
1. `[general task] has a variety of applications such as [xxx], [xxx], and [xxx].`
|
|
129
121
|
2. `This paper focuses on the specific setting of recovering/reconstructing/estimating [xxx output] from [xxx input].`
|
|
130
122
|
|
|
131
|
-
Local cite:
|
|
132
|
-
|
|
133
|
-
1. `references/examples/introduction/version-3-general-to-specific-setting.md`
|
|
134
|
-
|
|
135
123
|
### Version 4
|
|
136
124
|
|
|
137
125
|
`Version 4: If the task is familiar, introduce applications directly and expose the target technical challenge in the opening paragraph via previous methods (failure cases / target metric improvements).`
|
|
@@ -156,10 +144,6 @@ Expert note:
|
|
|
156
144
|
3. Typical Version 4 flow: Part 1 (task + application and directly expose challenge via previous methods 1) -> Part 2 (previous methods 2 try to solve it but still fail) -> Part 3 (our method).
|
|
157
145
|
4. More common general flow: Part 1 (task + application) -> Part 2 (previous methods 1 + limitation) -> Part 3 (previous methods 2 + limitation; here the target challenge emerges) -> Part 4 (our method).
|
|
158
146
|
|
|
159
|
-
Local cite:
|
|
160
|
-
|
|
161
|
-
1. `references/examples/introduction/version-4-open-with-challenge.md`
|
|
162
|
-
|
|
163
147
|
## Part B: Introduce Technical Challenge for Previous Methods (Very Important)
|
|
164
148
|
|
|
165
149
|
Purpose:
|
|
@@ -200,10 +184,6 @@ Sentence skeleton:
|
|
|
200
184
|
3. `Recently, ... methods ... However, they ... because ...`
|
|
201
185
|
4. `To overcome this challenge, ... methods ... However, they ... because ...`
|
|
202
186
|
|
|
203
|
-
Local cite:
|
|
204
|
-
|
|
205
|
-
1. `references/examples/introduction/technical-challenge-version-1-existing-task.md`
|
|
206
|
-
|
|
207
187
|
### Technical-Challenge Version 2 (existing task + our insight seen in traditional methods)
|
|
208
188
|
|
|
209
189
|
`Version 2: For existing tasks, when our insight has historical roots in traditional methods, use that line as conceptual backing and then show why new methods still fail.`
|
|
@@ -223,10 +203,6 @@ Sentence skeleton:
|
|
|
223
203
|
3. `However, these methods still ... because ...`
|
|
224
204
|
4. `To overcome this challenge, newer methods ... However, they ... because ...`
|
|
225
205
|
|
|
226
|
-
Local cite:
|
|
227
|
-
|
|
228
|
-
1. `references/examples/introduction/technical-challenge-version-2-existing-task-insight-backed-by-traditional.md`
|
|
229
|
-
|
|
230
206
|
### Technical-Challenge Version 3 (novel task, no direct methods)
|
|
231
207
|
|
|
232
208
|
`Version 3: For novel tasks without direct prior methods, define the challenge directly and decompose it into several concrete challenge points.`
|
|
@@ -245,10 +221,6 @@ Sentence skeleton:
|
|
|
245
221
|
3. `Second, ...`
|
|
246
222
|
4. `Finally, ...`
|
|
247
223
|
|
|
248
|
-
Local cite:
|
|
249
|
-
|
|
250
|
-
1. `references/examples/introduction/technical-challenge-version-3-novel-task.md`
|
|
251
|
-
|
|
252
224
|
## Part C: Introduce Our Pipeline for Solving the Challenge
|
|
253
225
|
|
|
254
226
|
Key questions before writing:
|
|
@@ -287,10 +259,6 @@ Sentence skeleton:
|
|
|
287
259
|
5. `In contrast to previous methods, ...`
|
|
288
260
|
6. `Another advantage of the proposed method is that ...`
|
|
289
261
|
|
|
290
|
-
Local cite:
|
|
291
|
-
|
|
292
|
-
1. `references/examples/introduction/pipeline-version-1-one-contribution-multi-advantages.md`
|
|
293
|
-
|
|
294
262
|
### Pipeline Version 2
|
|
295
263
|
|
|
296
264
|
`Version 2: Two contributions, and one teaser figure to present the basic idea.`
|
|
@@ -313,10 +281,6 @@ Sentence skeleton:
|
|
|
313
281
|
6. `However, ...` (remaining challenge)
|
|
314
282
|
7. `Specifically, ...` (contribution 2)
|
|
315
283
|
|
|
316
|
-
Local cite:
|
|
317
|
-
|
|
318
|
-
1. `references/examples/introduction/pipeline-version-2-two-contributions.md`
|
|
319
|
-
|
|
320
284
|
### Pipeline Version 3
|
|
321
285
|
|
|
322
286
|
`Version 3: Build on a prior pipeline and introduce one new module, with a teaser figure for the basic idea.`
|
|
@@ -337,10 +301,6 @@ Sentence skeleton:
|
|
|
337
301
|
4. `Considering that ..., we introduce ...`
|
|
338
302
|
5. `In contrast to ..., our module ...`
|
|
339
303
|
|
|
340
|
-
Local cite:
|
|
341
|
-
|
|
342
|
-
1. `references/examples/introduction/pipeline-version-3-new-module-on-existing-pipeline.md`
|
|
343
|
-
|
|
344
304
|
### Pipeline Version 4
|
|
345
305
|
|
|
346
306
|
`Version 4: Contribution comes from one important observation. Introduce key innovation first, then a listener-friendly observation as motivation, then method details, then benefits.`
|
|
@@ -359,10 +319,6 @@ Sentence skeleton:
|
|
|
359
319
|
3. `Considering that ..., we ...`
|
|
360
320
|
4. `This leads to ... and achieves ...`
|
|
361
321
|
|
|
362
|
-
Local cite:
|
|
363
|
-
|
|
364
|
-
1. `references/examples/introduction/pipeline-version-4-observation-driven.md`
|
|
365
|
-
|
|
366
322
|
### Not Recommended Writing
|
|
367
323
|
|
|
368
324
|
`Not recommended: If the method is simple, do not hide concrete method design in Introduction and only describe abstract insights to make the work look novel.`
|
|
@@ -379,25 +335,9 @@ Why not recommended (writing structure warning):
|
|
|
379
335
|
2. Introducing many new terms without mechanism-level explanation creates a novelty illusion.
|
|
380
336
|
3. Reviewers may interpret this as shallow or incremental work.
|
|
381
337
|
|
|
382
|
-
|
|
383
|
-
|
|
384
|
-
|
|
385
|
-
|
|
386
|
-
## Example Bank
|
|
387
|
-
|
|
388
|
-
1. `references/examples/introduction-examples.md`
|
|
389
|
-
2. `references/examples/introduction/version-1-task-then-application.md`
|
|
390
|
-
3. `references/examples/introduction/version-2-application-first.md`
|
|
391
|
-
4. `references/examples/introduction/version-3-general-to-specific-setting.md`
|
|
392
|
-
5. `references/examples/introduction/version-4-open-with-challenge.md`
|
|
393
|
-
6. `references/examples/introduction/technical-challenge-version-1-existing-task.md`
|
|
394
|
-
7. `references/examples/introduction/technical-challenge-version-2-existing-task-insight-backed-by-traditional.md`
|
|
395
|
-
8. `references/examples/introduction/technical-challenge-version-3-novel-task.md`
|
|
396
|
-
9. `references/examples/introduction/pipeline-version-1-one-contribution-multi-advantages.md`
|
|
397
|
-
10. `references/examples/introduction/pipeline-version-2-two-contributions.md`
|
|
398
|
-
11. `references/examples/introduction/pipeline-version-3-new-module-on-existing-pipeline.md`
|
|
399
|
-
12. `references/examples/introduction/pipeline-version-4-observation-driven.md`
|
|
400
|
-
13. `references/examples/introduction/pipeline-not-recommended-abstract-only.md`
|
|
338
|
+
## Usage Note
|
|
339
|
+
|
|
340
|
+
This vendored guide keeps the introduction patterns but omits the original example-bank files. Treat the templates and sentence skeletons here as the canonical reference inside `superlab`.
|
|
401
341
|
|
|
402
342
|
## Quick Quality Checklist
|
|
403
343
|
|