superlab 0.1.0 → 0.1.2

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.
Files changed (49) hide show
  1. package/README.md +23 -23
  2. package/README.zh-CN.md +22 -21
  3. package/lib/i18n.cjs +626 -23
  4. package/lib/install.cjs +31 -0
  5. package/package-assets/claude/commands/lab/spec.md +1 -1
  6. package/package-assets/claude/commands/lab/write.md +1 -1
  7. package/package-assets/codex/prompts/lab-spec.md +1 -1
  8. package/package-assets/codex/prompts/lab-write.md +1 -1
  9. package/package-assets/shared/changes/README.md +10 -0
  10. package/package-assets/shared/config/workflow.json +5 -0
  11. package/package-assets/shared/context/decisions.md +11 -0
  12. package/package-assets/shared/context/evidence-index.md +16 -0
  13. package/package-assets/shared/context/mission.md +27 -0
  14. package/package-assets/shared/context/open-questions.md +11 -0
  15. package/package-assets/shared/context/state.md +19 -0
  16. package/package-assets/shared/examples/minimal-uplift-workflow.md +4 -4
  17. package/package-assets/shared/skills/lab/SKILL.md +54 -9
  18. package/package-assets/shared/skills/lab/references/brainstorming-integration.md +21 -0
  19. package/package-assets/shared/skills/lab/references/paper-writing/abstract.md +102 -0
  20. package/package-assets/shared/skills/lab/references/paper-writing/conclusion.md +35 -0
  21. package/package-assets/shared/skills/lab/references/paper-writing/does-my-writing-flow-source.md +45 -0
  22. package/package-assets/shared/skills/lab/references/paper-writing/experiments.md +102 -0
  23. package/package-assets/shared/skills/lab/references/paper-writing/introduction.md +408 -0
  24. package/package-assets/shared/skills/lab/references/paper-writing/method.md +196 -0
  25. package/package-assets/shared/skills/lab/references/paper-writing/paper-review.md +86 -0
  26. package/package-assets/shared/skills/lab/references/paper-writing/related-work.md +41 -0
  27. package/package-assets/shared/skills/lab/references/paper-writing-integration.md +29 -28
  28. package/package-assets/shared/skills/lab/references/workflow.md +1 -1
  29. package/package-assets/shared/skills/lab/stages/idea.md +43 -7
  30. package/package-assets/shared/skills/lab/stages/iterate.md +32 -0
  31. package/package-assets/shared/skills/lab/stages/report.md +19 -0
  32. package/package-assets/shared/skills/lab/stages/review.md +30 -0
  33. package/package-assets/shared/skills/lab/stages/run.md +17 -0
  34. package/package-assets/shared/skills/lab/stages/spec.md +36 -4
  35. package/package-assets/shared/skills/lab/stages/write.md +47 -15
  36. package/package-assets/shared/templates/design.md +10 -0
  37. package/package-assets/shared/templates/idea.md +76 -8
  38. package/package-assets/shared/templates/iteration-report.md +4 -0
  39. package/package-assets/shared/templates/paper-plan.md +12 -0
  40. package/package-assets/shared/templates/paper-section.md +24 -6
  41. package/package-assets/shared/templates/paper-section.tex +10 -0
  42. package/package-assets/shared/templates/paper.tex +29 -0
  43. package/package-assets/shared/templates/proposal.md +10 -0
  44. package/package-assets/shared/templates/review-checklist.md +23 -0
  45. package/package-assets/shared/templates/spec.md +7 -2
  46. package/package-assets/shared/templates/tasks.md +3 -1
  47. package/package-assets/shared/templates/write-iteration.md +5 -0
  48. package/package.json +3 -3
  49. package/package-assets/shared/scripts/check_openspec.sh +0 -10
package/lib/install.cjs CHANGED
@@ -30,6 +30,14 @@ const ASSET_GROUPS = {
30
30
  from: path.join(REPO_ROOT, "package-assets", "shared", "templates"),
31
31
  to: path.join(".superlab", "templates"),
32
32
  },
33
+ {
34
+ from: path.join(REPO_ROOT, "package-assets", "shared", "config"),
35
+ to: path.join(".superlab", "config"),
36
+ },
37
+ {
38
+ from: path.join(REPO_ROOT, "package-assets", "shared", "changes"),
39
+ to: path.join(".superlab", "changes"),
40
+ },
33
41
  {
34
42
  from: path.join(REPO_ROOT, "package-assets", "shared", "scripts"),
35
43
  to: path.join(".superlab", "scripts"),
@@ -38,6 +46,10 @@ const ASSET_GROUPS = {
38
46
  from: path.join(REPO_ROOT, "package-assets", "shared", "examples"),
39
47
  to: path.join(".superlab", "examples"),
40
48
  },
49
+ {
50
+ from: path.join(REPO_ROOT, "package-assets", "shared", "context"),
51
+ to: path.join(".superlab", "context"),
52
+ },
41
53
  ],
42
54
  };
43
55
 
@@ -127,9 +139,28 @@ function localizeInstalledAssets(targetDir, lang) {
127
139
  path.join(".claude", "commands", "lab", "report.md"),
128
140
  path.join(".claude", "commands", "lab", "write.md"),
129
141
  path.join(".codex", "skills", "lab", "SKILL.md"),
142
+ path.join(".codex", "skills", "lab", "stages", "idea.md"),
130
143
  path.join(".codex", "skills", "lab", "stages", "write.md"),
131
144
  path.join(".claude", "skills", "lab", "SKILL.md"),
145
+ path.join(".claude", "skills", "lab", "stages", "idea.md"),
132
146
  path.join(".claude", "skills", "lab", "stages", "write.md"),
147
+ path.join(".superlab", "templates", "idea.md"),
148
+ path.join(".superlab", "templates", "proposal.md"),
149
+ path.join(".superlab", "templates", "design.md"),
150
+ path.join(".superlab", "templates", "spec.md"),
151
+ path.join(".superlab", "templates", "tasks.md"),
152
+ path.join(".superlab", "templates", "iteration-report.md"),
153
+ path.join(".superlab", "templates", "review-checklist.md"),
154
+ path.join(".superlab", "templates", "final-report.md"),
155
+ path.join(".superlab", "templates", "paper-plan.md"),
156
+ path.join(".superlab", "templates", "paper-section.md"),
157
+ path.join(".superlab", "templates", "write-iteration.md"),
158
+ path.join(".superlab", "config", "workflow.json"),
159
+ path.join(".superlab", "context", "mission.md"),
160
+ path.join(".superlab", "context", "state.md"),
161
+ path.join(".superlab", "context", "decisions.md"),
162
+ path.join(".superlab", "context", "evidence-index.md"),
163
+ path.join(".superlab", "context", "open-questions.md"),
133
164
  ];
134
165
 
135
166
  for (const relativePath of relativePaths) {
@@ -1,6 +1,6 @@
1
1
  ---
2
2
  name: "LAB: Spec"
3
- description: Convert an approved idea into OpenSpec spec-driven artifacts
3
+ description: Convert an approved idea into a lab change directory
4
4
  category: Workflow
5
5
  tags: [workflow, research, spec]
6
6
  ---
@@ -7,4 +7,4 @@ tags: [workflow, research, writing]
7
7
 
8
8
  Use the installed `lab` skill at `.claude/skills/lab/SKILL.md`.
9
9
 
10
- This command runs the `/lab:write` stage. It must read the matching section reference from the companion `research-paper-writing` skill, plus `paper-review.md` and `does-my-writing-flow-source.md`, before revising one section.
10
+ This command runs the `/lab:write` stage. It must read the matching section reference from `.claude/skills/lab/references/paper-writing/`, plus `paper-review.md` and `does-my-writing-flow-source.md`, build a mini-outline, and then revise only one section.
@@ -1,5 +1,5 @@
1
1
  ---
2
- description: Convert an approved idea into OpenSpec spec-driven artifacts
2
+ description: Convert an approved idea into a lab change directory
3
3
  argument-hint: approved idea context
4
4
  ---
5
5
 
@@ -5,4 +5,4 @@ argument-hint: section or writing target
5
5
 
6
6
  Use the installed `lab` skill at `.codex/skills/lab/SKILL.md`.
7
7
 
8
- This command runs the `/lab:write` stage. It must read the matching section reference from the companion `research-paper-writing` skill, plus `paper-review.md` and `does-my-writing-flow-source.md`, before revising one section.
8
+ This command runs the `/lab:write` stage. It must read the matching section reference from `.codex/skills/lab/references/paper-writing/`, plus `paper-review.md` and `does-my-writing-flow-source.md`, build a mini-outline, and then revise only one section.
@@ -0,0 +1,10 @@
1
+ # `.superlab/changes`
2
+
3
+ Each approved `/lab:spec` change lives in one directory:
4
+
5
+ - `.superlab/changes/<change-id>/proposal.md`
6
+ - `.superlab/changes/<change-id>/design.md`
7
+ - `.superlab/changes/<change-id>/spec.md`
8
+ - `.superlab/changes/<change-id>/tasks.md`
9
+
10
+ This keeps spec artifacts grouped under `lab` instead of depending on external directory conventions.
@@ -0,0 +1,5 @@
1
+ {
2
+ "workflow_language": "en",
3
+ "paper_language": "en",
4
+ "paper_format": "latex"
5
+ }
@@ -0,0 +1,11 @@
1
+ # Decision Log
2
+
3
+ Record stable decisions that later stages should not silently overturn.
4
+
5
+ ## Decisions
6
+
7
+ 1. Decision:
8
+ Reason:
9
+ Stage:
10
+ Evidence:
11
+ Revisit trigger:
@@ -0,0 +1,16 @@
1
+ # Evidence Index
2
+
3
+ Map every important claim to concrete artifacts.
4
+
5
+ ## Claims
6
+
7
+ 1. Claim:
8
+ Supporting artifacts:
9
+ Metrics:
10
+ Limits or caveats:
11
+
12
+ ## Rejected Claims
13
+
14
+ 1. Claim:
15
+ Why it was weakened or removed:
16
+ Artifact showing the failure:
@@ -0,0 +1,27 @@
1
+ # Research Mission
2
+
3
+ ## Core Problem
4
+
5
+ - One-sentence problem:
6
+ - Why it matters:
7
+ - Target failure case:
8
+
9
+ ## Success Criteria
10
+
11
+ - Primary metric:
12
+ - Success threshold:
13
+ - Required baselines:
14
+ - Minimum evidence needed:
15
+
16
+ ## Frozen Boundaries
17
+
18
+ - Dataset or benchmark scope:
19
+ - Split policy:
20
+ - Evaluation protocol:
21
+ - Hard constraints:
22
+
23
+ ## Campaign Status
24
+
25
+ - Approved direction:
26
+ - Current owner or session:
27
+ - Last stage that updated this mission:
@@ -0,0 +1,11 @@
1
+ # Open Questions
2
+
3
+ Track unresolved issues so the workflow does not invent answers silently.
4
+
5
+ ## Active Questions
6
+
7
+ 1. Question:
8
+ Why it matters:
9
+ Best current options:
10
+ Resolution owner:
11
+ Target stage:
@@ -0,0 +1,19 @@
1
+ # Workflow State
2
+
3
+ ## Current Stage
4
+
5
+ - Active stage:
6
+ - Current objective:
7
+ - Next required output:
8
+
9
+ ## Latest Update
10
+
11
+ - Last completed action:
12
+ - Latest artifact path:
13
+ - Latest run or report id:
14
+
15
+ ## Next Step
16
+
17
+ - Immediate next action:
18
+ - Blocking issue:
19
+ - Human decision needed:
@@ -20,10 +20,10 @@ Use `/lab:spec` after approving the idea artifact.
20
20
 
21
21
  Expected artifacts:
22
22
 
23
- - `proposal.md`
24
- - `design.md`
25
- - `specs/<capability>/spec.md`
26
- - `tasks.md`
23
+ - `.superlab/changes/<change-id>/proposal.md`
24
+ - `.superlab/changes/<change-id>/design.md`
25
+ - `.superlab/changes/<change-id>/spec.md`
26
+ - `.superlab/changes/<change-id>/tasks.md`
27
27
 
28
28
  ## 3. Run
29
29
 
@@ -1,6 +1,6 @@
1
1
  ---
2
2
  name: lab
3
- description: Strict research workflow for idea development, OpenSpec specification, small-scale experiment execution, bounded iteration, reviewer-grade critique, final reporting, and paper-writing.
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.
4
4
  ---
5
5
 
6
6
  # /lab Skill
@@ -9,10 +9,18 @@ Use this skill when the user invokes `/lab:*` or asks for the structured researc
9
9
 
10
10
  ## Global Rules
11
11
 
12
- - Treat OpenSpec CLI as required from `/lab:spec` onward.
13
12
  - Keep idea generation, specification, execution, review, and reporting as separate stages.
14
13
  - Keep paper writing separate from experiment execution and reporting.
14
+ - Start each stage with a concise user-facing summary before writing artifacts.
15
+ - 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
+ - When a missing assumption would materially change the stage outcome, ask one clarifying question at a time.
17
+ - When there are multiple viable paths, present 2-3 approaches with trade-offs and a recommendation before converging.
18
+ - When a stage materially sets downstream direction, keep an explicit approval gate before proceeding.
15
19
  - Write durable artifacts to disk instead of leaving key decisions only in chat.
20
+ - Use `.superlab/config/workflow.json` as the global contract for workflow language, paper language, and paper format.
21
+ - Use `.superlab/context/`` as the shared project state for both Codex and Claude entrypoints.
22
+ - Workflow artifacts should follow the installed workflow language.
23
+ - Final paper output should default to LaTeX, and its manuscript language should be decided separately from the workflow language.
16
24
  - Separate sourced facts from model-generated hypotheses.
17
25
  - Preserve failed runs, failed ideas, and limitations.
18
26
 
@@ -21,23 +29,37 @@ Use this skill when the user invokes `/lab:*` or asks for the structured researc
21
29
  ### `/lab:idea`
22
30
 
23
31
  - Search relevant literature, baselines, datasets, and evaluation metrics before proposing a plan.
32
+ - Read `.superlab/context/`mission.md` and `.superlab/context/`open-questions.md` before drafting.
33
+ - Ask one clarifying question at a time when critical ambiguity remains.
34
+ - State the problem, the failure case, and why the problem matters before proposing solutions.
35
+ - Classify the idea by contribution category and breakthrough level.
36
+ - Compare against existing methods explicitly and state why the idea should be better.
24
37
  - Distinguish sourced evidence from generated innovation claims.
38
+ - End with three meaningful points that are clear, short, and easy to scan.
39
+ - Produce 2-3 candidate approaches with trade-offs before recommending one.
25
40
  - Critique the idea before converging on it.
41
+ - Keep an explicit approval gate before `/lab:spec`.
26
42
  - Write idea artifacts with the template in `.superlab/templates/idea.md`.
43
+ - Update `.superlab/context/`mission.md`, `.superlab/context/`decisions.md`, and `.superlab/context/`open-questions.md` after convergence.
27
44
  - Do not implement code in this stage.
28
45
 
29
46
  ### `/lab:spec`
30
47
 
31
- - Require `bash scripts/check_openspec.sh`.
32
- - Convert the approved idea into OpenSpec `spec-driven` artifacts using `.superlab/templates/proposal.md`, `.superlab/templates/design.md`, `.superlab/templates/spec.md`, and `.superlab/templates/tasks.md`.
48
+ - Read `.superlab/config/workflow.json` before drafting the change.
49
+ - Read `.superlab/context/`mission.md`, `.superlab/context/`decisions.md`, and `.superlab/context/`state.md` before drafting the change.
50
+ - Use `.superlab/changes/<change-id>/` as the canonical lab change directory.
51
+ - Convert the approved idea into lab change artifacts using `.superlab/templates/proposal.md`, `.superlab/templates/design.md`, `.superlab/templates/spec.md`, and `.superlab/templates/tasks.md`.
52
+ - Update `.superlab/context/`state.md` and `.superlab/context/`decisions.md` after freezing the spec.
33
53
  - Do not skip task definition.
34
54
 
35
55
  ### `/lab:run`
36
56
 
37
57
  - Start with the smallest meaningful experiment.
58
+ - Read `.superlab/context/`mission.md` and `.superlab/context/`state.md` before choosing the run.
38
59
  - Register the run with `.superlab/scripts/register_run.py`.
39
60
  - Normalize the result with `.superlab/scripts/eval_report.py`.
40
61
  - Validate normalized output with `.superlab/scripts/validate_results.py`.
62
+ - Update `.superlab/context/`state.md` and `.superlab/context/`evidence-index.md` after the run.
41
63
 
42
64
  ### `/lab:iterate`
43
65
 
@@ -47,45 +69,66 @@ Use this skill when the user invokes `/lab:*` or asks for the structured researc
47
69
  - primary metric
48
70
  - success threshold
49
71
  - verification commands
72
+ - completion_promise
50
73
  - maximum iteration count
51
74
  - Only change implementation hypotheses within the loop.
52
75
  - Require a normalized evaluation report each round.
76
+ - Read `.superlab/context/`mission.md`, `.superlab/context/`state.md`, `.superlab/context/`decisions.md`, and `.superlab/context/`evidence-index.md` at the start of each round.
77
+ - Switch to diagnostic mode if risk increases for two consecutive rounds.
53
78
  - Write round reports with `.superlab/templates/iteration-report.md`.
54
- - Stop at threshold success or iteration cap.
79
+ - Update `.superlab/context/`state.md`, `.superlab/context/`decisions.md`, `.superlab/context/`evidence-index.md`, and `.superlab/context/`open-questions.md` each round as needed.
80
+ - Stop at threshold success or iteration cap, and record blockers plus next-best actions when the campaign ends without success.
55
81
 
56
82
  ### `/lab:review`
57
83
 
58
84
  - Work in reviewer mode, not implementation mode.
85
+ - Read `.superlab/context/`mission.md`, `.superlab/context/`decisions.md`, and `.superlab/context/`evidence-index.md` before reviewing.
86
+ - Start with a concise summary of what is being reviewed and the top review question.
59
87
  - Prioritize methodology, fairness, leakage, statistics, ablations, and claim discipline.
88
+ - Output findings first, then fatal flaws, then fix priority, then residual risks.
60
89
  - Use `.superlab/templates/review-checklist.md`.
90
+ - Write durable review conclusions back to `.superlab/context/`state.md` or `.superlab/context/`open-questions.md` when they affect later stages.
61
91
 
62
92
  ### `/lab:report`
63
93
 
64
94
  - Summarize all validated iteration summaries.
95
+ - Read `.superlab/context/`mission.md`, `.superlab/context/`state.md`, `.superlab/context/`decisions.md`, and `.superlab/context/`evidence-index.md` before drafting.
65
96
  - Aggregate them with `.superlab/scripts/summarize_iterations.py`.
66
97
  - Write the final document with `.superlab/templates/final-report.md`.
67
98
  - Keep failed attempts and limitations visible.
99
+ - Update `.superlab/context/`state.md` and `.superlab/context/`evidence-index.md` with report-level handoff notes.
68
100
 
69
101
  ### `/lab:write`
70
102
 
71
103
  - Start only after `report` artifacts are stable enough to support paper claims.
104
+ - Read `.superlab/config/workflow.json` before drafting and enforce its `paper_language` and `paper_format`.
105
+ - Read `.superlab/context/`mission.md`, `.superlab/context/`decisions.md`, and `.superlab/context/`evidence-index.md` before drafting.
72
106
  - Write one paper section or one explicit subproblem per round.
73
107
  - Bind each claim to evidence from `report`, iteration reports, or normalized summaries.
74
- - Write paper artifacts with `.superlab/templates/paper-plan.md`, `.superlab/templates/paper-section.md`, and `.superlab/templates/write-iteration.md`.
75
- - Use the companion `research-paper-writing` skill references for the current section and required review passes.
108
+ - Write planning artifacts with `.superlab/templates/paper-plan.md`, `.superlab/templates/paper-section.md`, and `.superlab/templates/write-iteration.md`.
109
+ - Write final manuscript artifacts with `.superlab/templates/paper.tex` and `.superlab/templates/paper-section.tex`.
110
+ - Use the vendored paper-writing references under `skills/lab/references/paper-writing/`.
111
+ - Load only the current section guide, plus `paper-review.md` and `does-my-writing-flow-source.md`.
112
+ - Build a compact mini-outline before prose.
113
+ - For each subsection, explicitly cover motivation, design, and technical advantage when applicable.
114
+ - Keep terminology stable across rounds and sections.
115
+ - If a claim is not supported by evidence, weaken or remove it.
116
+ - Before finalizing a round, append and answer the five-dimension self-review checklist and revise unresolved items.
76
117
  - Apply paper-writing discipline without changing experimental truth.
77
118
  - If the evidence is insufficient, stop and route back to `review` or `iterate`.
119
+ - Update `.superlab/context/`state.md` and `.superlab/context/`evidence-index.md` when section-level claim status changes.
78
120
 
79
121
  ## Hard Gates
80
122
 
81
123
  - No implementation before `/lab:spec`.
82
124
  - No unconstrained iteration. Every `/lab:iterate` campaign must declare done criteria and `max_iterations`.
83
125
  - No final report without validated normalized results.
84
- - No paper-writing round without stable report artifacts and evidence links.
126
+ - No paper-writing round without stable report artifacts, evidence links, and LaTeX manuscript output.
85
127
 
86
128
  ## References
87
129
 
88
130
  - Workflow summary: `.codex/skills/lab/references/workflow.md` or `.claude/skills/lab/references/workflow.md`
131
+ - Brainstorming integration: `.codex/skills/lab/references/brainstorming-integration.md` or `.claude/skills/lab/references/brainstorming-integration.md`
89
132
  - Idea stage guide: `.codex/skills/lab/stages/idea.md` or `.claude/skills/lab/stages/idea.md`
90
133
  - Spec stage guide: `.codex/skills/lab/stages/spec.md` or `.claude/skills/lab/stages/spec.md`
91
134
  - Run stage guide: `.codex/skills/lab/stages/run.md` or `.claude/skills/lab/stages/run.md`
@@ -94,7 +137,9 @@ Use this skill when the user invokes `/lab:*` or asks for the structured researc
94
137
  - Report stage guide: `.codex/skills/lab/stages/report.md` or `.claude/skills/lab/stages/report.md`
95
138
  - Write stage guide: `.codex/skills/lab/stages/write.md` or `.claude/skills/lab/stages/write.md`
96
139
  - Paper-writing integration: `.codex/skills/lab/references/paper-writing-integration.md` or `.claude/skills/lab/references/paper-writing-integration.md`
97
- - Companion references: `research-paper-writing/references/{abstract,introduction,related-work,method,experiments,conclusion,paper-review,does-my-writing-flow-source}.md`
140
+ - 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`
98
141
  - Command adapters: the installed `/lab:*` command assets
142
+ - Shared workflow config: `.superlab/config/workflow.json`
143
+ - Shared project context: `.superlab/context/`{mission,state,decisions,evidence-index,open-questions}.md`
99
144
  - Templates: `.superlab/templates/`
100
145
  - Scripts: `.superlab/scripts/`
@@ -0,0 +1,21 @@
1
+ # Brainstorming Integration for `/lab`
2
+
3
+ This reference keeps brainstorming-style interaction rules centralized so each `/lab` stage can stay small and stage-specific.
4
+
5
+ ## Shared Rules
6
+
7
+ - Start with a concise user-facing summary before creating or revising artifacts.
8
+ - If a missing assumption would materially change the stage outcome, ask one clarifying question at a time.
9
+ - If multiple viable directions exist, present 2-3 approaches with trade-offs and a recommendation before converging.
10
+ - Keep an explicit approval gate when the stage commits downstream direction or locks in scope.
11
+ - Prefer thin stage-specific contracts over copying the full brainstorming workflow into every stage guide.
12
+
13
+ ## Stage Adaptation
14
+
15
+ - `idea`: use the full pattern most strongly because ambiguity and design exploration are highest here.
16
+ - `spec`: compare viable change decomposition or validation plans before freezing the lab change directory.
17
+ - `run`: compare the smallest meaningful experiment options before spending compute.
18
+ - `iterate`: compare the next 2-3 hypotheses when there is more than one defensible next move.
19
+ - `review`: clarify review scope only when ambiguity changes findings, then stay in reviewer mode.
20
+ - `report`: compare report framing options only when they change interpretation or reader takeaway.
21
+ - `write`: compare section-level narrative structures only when more than one structure is defensible.
@@ -0,0 +1,102 @@
1
+ # Abstract Writing Guide
2
+
3
+ ## Goal
4
+
5
+ Write a strong abstract by doing three things repeatedly:
6
+
7
+ 1. Think through the abstract logic first.
8
+ 2. Follow one template (Version 1/2/3 below).
9
+ 3. Revise the abstract many times.
10
+
11
+ ## Pre-Writing Questions (Important)
12
+
13
+ Answer these before writing:
14
+
15
+ 1. What technical problem do we solve, and why is there no well-established solution? (important)
16
+ 2. What is our technical contribution?
17
+ 3. Why can our method work in essence?
18
+ 4. What technical advantage and new insight do we provide? (important)
19
+
20
+ ## Version 1: Challenge -> Contribution
21
+
22
+ Introduce the technical challenge, then use one to two sentences to present the technical contribution that solves the challenge.
23
+
24
+ ### Structure
25
+
26
+ 1. Task.
27
+ 2. Technical challenge for previous methods.
28
+ 3. One to two sentences introducing the technical contribution for solving the challenge.
29
+ 4. Benefits of the technical contribution.
30
+ 5. Experiment summary.
31
+
32
+ ### Expert Notes
33
+
34
+ 1. Discuss previous work around the technical challenge that we actually solve.
35
+ 2. For the contribution sentence(s), usually mention the technical term/name only; do not explain every detailed step.
36
+ 3. The technical term must be easy to understand; readers should not feel a jump.
37
+ 4. This ability is very important for writing a good abstract.
38
+
39
+ Version 1 local cite:
40
+
41
+ 1. `references/examples/abstract/template-a.md`
42
+
43
+ ## Version 2: Challenge -> Insight -> Contribution
44
+
45
+ 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.
46
+
47
+ ### Structure
48
+
49
+ 1. Task.
50
+ 2. Technical challenge for previous methods.
51
+ 3. One sentence introducing the insight for solving the challenge.
52
+ 4. One to two sentences introducing the technical contribution that implements the insight.
53
+ 5. Benefits of technical novelty.
54
+ 6. Experiment summary.
55
+
56
+ ### Expert Notes
57
+
58
+ 1. Discuss previous work around the technical challenge that we actually solve.
59
+ 2. Introduce the insight in one clear sentence.
60
+ 3. For the implementation sentence(s), usually mention the technical term/name only; do not explain every detailed step.
61
+ 4. The technical term must be easy to understand; do not create a jump in reading.
62
+ 5. This ability is very important for writing a good abstract.
63
+
64
+ Version 2 local cite:
65
+
66
+ 1. `references/examples/abstract/template-b.md`
67
+
68
+ ## Version 3: Multiple Contributions
69
+
70
+ Version 3: When there are multiple technical contributions, describe each contribution together with its technical advantage.
71
+
72
+ ### Structure
73
+
74
+ 1. Task.
75
+ 2. If needed, one contrast sentence about prior methods.
76
+ 3. Contribution sentence 1 + technical advantage.
77
+ 4. Contribution sentence 2 + technical advantage.
78
+ 5. Contribution sentence 3 + technical advantage.
79
+ 6. Experiment summary.
80
+
81
+ ### Expert Notes
82
+
83
+ 1. When there are multiple technical contributions, describe each contribution together with its technical advantage.
84
+ 2. The ability to express "contribution + advantage" in one sentence is very important for writing a good abstract.
85
+
86
+ Version 3 local cite:
87
+
88
+ 1. `references/examples/abstract/template-c.md`
89
+
90
+ ## Example Bank
91
+
92
+ 1. `references/examples/abstract-examples.md`
93
+ 2. `references/examples/abstract/template-a.md`
94
+ 3. `references/examples/abstract/template-b.md`
95
+ 4. `references/examples/abstract/template-c.md`
96
+
97
+ ## Abstract Quality Checklist
98
+
99
+ 1. Can a reader identify task, challenge, insight/contribution, and results in one pass?
100
+ 2. Are all major claims supported by experiments?
101
+ 3. Are technical names self-contained and readable?
102
+ 4. Is there any sentence that mixes too many messages?
@@ -0,0 +1,35 @@
1
+ # Conclusion Writing Guide
2
+
3
+ ## Goal
4
+
5
+ Close the paper with clear takeaways and credible limitations.
6
+
7
+ ## Structure
8
+
9
+ 1. Restate solved problem and core technical idea.
10
+ 2. Summarize strongest evidence from experiments.
11
+ 3. State practical impact or new insight.
12
+ 4. Add limitation paragraph.
13
+ 5. End with concrete future direction.
14
+
15
+ ## Limitation Guidance
16
+
17
+ Prefer limitations tied to task goal/setting boundaries, for example:
18
+
19
+ 1. Data regime limitation (e.g., only short sequences).
20
+ 2. Assumption limitation (e.g., controlled viewpoints only).
21
+ 3. Deployment scope limitation (e.g., specific sensor setup).
22
+
23
+ Avoid framing conclusion around fixable implementation flaws unless they critically define your method's scope.
24
+
25
+ ## Distinguish Limitation Types
26
+
27
+ 1. Technical defect: underperforms strong baselines on key metrics or causes unacceptable tradeoff.
28
+ 2. Scope limitation: bounded by current task setting and still competitive vs. current SOTA.
29
+
30
+ ## Template
31
+
32
+ 1. This paper addresses [problem] by proposing [method].
33
+ 2. The key idea is [core insight], which enables [main benefit].
34
+ 3. Experiments show [main gains] across [datasets/settings].
35
+ 4. A current limitation is [scope boundary], and extending to [future setting] is an important next step.
@@ -0,0 +1,45 @@
1
+ # Does My Writing Flow?
2
+
3
+ Note: This file stores the source content extracted from the PDF, with light formatting cleanup for Markdown readability.
4
+
5
+ ## Original Content
6
+
7
+ ### Does My Writing Flow?
8
+
9
+ One of the most frequent questions writers ask themselves or others is "does my writing flow?" Other variations of this question include "does this make sense?" and "can you understand what I am saying?" The term flow is a vague term that writers use when describing some concern of clarity, coherence, or conciseness. However vague this term may be, writers know it is a very important concern about their work. If you find yourself concerned about the flow of your writing, then here are some strategies to improve it.
10
+
11
+ 1. Pretend you are the reader of your paper.
12
+
13
+ - Often when we write, our work makes sense to us because we are the ones who create it. However, at a certain point in the writing process, our writing may become unclear even to us. When we as authors begin to lose sight of our paper's train of thought, other readers are sure to be confused as well.
14
+ - By looking at your paper from the perspective of a reader, you are checking and making sure your writing is clear to someone who might not be as informed of the paper's topic as you are.
15
+ - Some questions you might ask to place yourself in the reader's shoes are:
16
+ 1. Would my classmates be able to understand the level of vocabulary I am using?
17
+ 2. How do my body paragraphs connect back to my thesis, and is the connection easy to see?
18
+ 3. Would someone not in my class understand what I am trying to say?
19
+ 2. Reverse-outlining
20
+
21
+ - Outlining is not only a great pre-writing exercise, but it also can serve as a great post-writing tool. Reverse-outlining means just what it sounds like. It breaks down an already written essay into its basic parts (such as thesis statement, topic-sentences, and the points of proof/explanation used within your body paragraphs), and it allows a writer to see how well topic sentences and paragraphs fit into an essay.
22
+ - Here is how to reverse outline:
23
+ 1. Write down the thesis statement.
24
+ 2. Write down each topic sentence of each body paragraph.
25
+ 3. Also write down the main points of evidence or explanation used within your body paragraphs.
26
+ 4. Check every topic sentence and make sure it is clearly related to a part of your thesis statement.
27
+ 5. Check all points of proof/explanation and make sure they pertain to the topic of the paragraph and provide adequate support.
28
+ 6. If there is a topic sentence that does not clearly relate to the thesis statement, then either revise it and its supporting points of proof/explanation or take it out entirely.
29
+ - If it is easy to write a reverse outline, then it's a good sign that your paper is well-organized. If you have a hard time creating a reverse outline, then your thesis statement and topic-sentences might be unclear.
30
+ 3. Add headings and sections to your paper.
31
+
32
+ - If you are not up to making a complete outline (or if you are not very good at outlining - lots of people aren't), then no need to feel bad. You can add headings and sections to your paper. This method achieves a similar effect to reverse outlining.
33
+ - By splitting a paper into sections and sub-sections with headings, the paper is telling the reader what each part is all about.
34
+ - For most papers, headings are not necessary. However, you can still make use of them as a tool for drafting and revision. By adding headers to the different sections of a paper, you can easily begin to see the main parts of your paper and how they work together.
35
+ 4. Use transitions or "flow" keywords.
36
+
37
+ - Using appropriate transition words improves the flow of your paper. These words act as guide posts, indicating the relationship between thoughts, sentences, or paragraphs. You can always make your essay flow better by adding appropriate transitional words and phrases.
38
+ - Transitional words and phrases:
39
+ - To show causes and effects: accordingly, as a result, because, consequently, hence, so, then, therefore, thus
40
+ - To show comparison: also, in the same way, likewise, similarly
41
+ - To show contrasts or exceptions: although, but, even though, however, in contrast, instead, nevertheless, nonetheless, on the contrary, on the one hand ... on the other hand, still, yet
42
+ - To show examples: even, for example, for instance, indeed, in fact, of course, such as
43
+ - To show place or position: above, adjacent to, below, beyond, finally, furthermore, last, moreover, next, too
44
+ - To show time: after, as soon as, at first, at the same time, before, eventually, finally, immediately, later, meanwhile, next, simultaneously, so far, soon, then, thereafter
45
+ - To signal a summary or conclusion: as a result, as we have seen, finally, in a word, in any event, in brief, in conclusion, in other words, in short, in the end, in a final analysis, on the whole, therefore, thus, to summarize