wtf-p 0.1.0
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/LICENSE +21 -0
- package/README.md +338 -0
- package/bin/install.js +358 -0
- package/bin/uninstall.js +485 -0
- package/commands/wtfp/analyze-bib.md +326 -0
- package/commands/wtfp/check-refs.md +205 -0
- package/commands/wtfp/create-outline.md +275 -0
- package/commands/wtfp/discuss-section.md +71 -0
- package/commands/wtfp/export-latex.md +216 -0
- package/commands/wtfp/help.md +342 -0
- package/commands/wtfp/insert-section.md +130 -0
- package/commands/wtfp/list-assumptions.md +109 -0
- package/commands/wtfp/map-project.md +197 -0
- package/commands/wtfp/new-paper.md +443 -0
- package/commands/wtfp/pause-writing.md +145 -0
- package/commands/wtfp/plan-revision.md +180 -0
- package/commands/wtfp/plan-section.md +247 -0
- package/commands/wtfp/polish-prose.md +177 -0
- package/commands/wtfp/progress.md +325 -0
- package/commands/wtfp/remove-section.md +147 -0
- package/commands/wtfp/research-gap.md +235 -0
- package/commands/wtfp/resume-writing.md +142 -0
- package/commands/wtfp/review-section.md +409 -0
- package/commands/wtfp/submit-milestone.md +211 -0
- package/commands/wtfp/write-section.md +273 -0
- package/package.json +40 -0
- package/write-the-f-paper/references/checkpoints.md +213 -0
- package/write-the-f-paper/references/continuation-format.md +223 -0
- package/write-the-f-paper/references/git-integration.md +241 -0
- package/write-the-f-paper/references/imrad-structure.md +212 -0
- package/write-the-f-paper/references/length-estimation.md +148 -0
- package/write-the-f-paper/references/plan-format.md +361 -0
- package/write-the-f-paper/references/principles.md +158 -0
- package/write-the-f-paper/references/questioning.md +132 -0
- package/write-the-f-paper/references/research-pitfalls.md +208 -0
- package/write-the-f-paper/templates/config.json +30 -0
- package/write-the-f-paper/templates/context.md +179 -0
- package/write-the-f-paper/templates/continue-here.md +142 -0
- package/write-the-f-paper/templates/data-inventory.md +142 -0
- package/write-the-f-paper/templates/discovery.md +146 -0
- package/write-the-f-paper/templates/issues.md +59 -0
- package/write-the-f-paper/templates/manuscript.md +253 -0
- package/write-the-f-paper/templates/narrative-arc.md +227 -0
- package/write-the-f-paper/templates/outline.md +274 -0
- package/write-the-f-paper/templates/phase-prompt.md +348 -0
- package/write-the-f-paper/templates/prior-drafts.md +204 -0
- package/write-the-f-paper/templates/project-context/argument-structure.md +267 -0
- package/write-the-f-paper/templates/project-context/bibliography.md +152 -0
- package/write-the-f-paper/templates/project-context/gaps.md +122 -0
- package/write-the-f-paper/templates/project-context/imrad.md +140 -0
- package/write-the-f-paper/templates/project-context/peer-review.md +152 -0
- package/write-the-f-paper/templates/project-context/style-guide.md +198 -0
- package/write-the-f-paper/templates/project-context/tools.md +170 -0
- package/write-the-f-paper/templates/project.md +185 -0
- package/write-the-f-paper/templates/research.md +384 -0
- package/write-the-f-paper/templates/review-comments.md +253 -0
- package/write-the-f-paper/templates/revision-issues.md +169 -0
- package/write-the-f-paper/templates/roadmap.md +187 -0
- package/write-the-f-paper/templates/section-archive.md +178 -0
- package/write-the-f-paper/templates/section-context.md +114 -0
- package/write-the-f-paper/templates/section.md +128 -0
- package/write-the-f-paper/templates/state.md +244 -0
- package/write-the-f-paper/templates/summary.md +277 -0
- package/write-the-f-paper/venues/acm-cs.yaml +102 -0
- package/write-the-f-paper/venues/arxiv-ml.yaml +103 -0
- package/write-the-f-paper/venues/ieee-cs.yaml +100 -0
- package/write-the-f-paper/venues/nature.yaml +81 -0
- package/write-the-f-paper/venues/thesis-chapter.yaml +101 -0
- package/write-the-f-paper/workflows/create-outline.md +462 -0
- package/write-the-f-paper/workflows/create-outline.wcn.md +194 -0
- package/write-the-f-paper/workflows/discuss-section.md +249 -0
- package/write-the-f-paper/workflows/discuss-section.wcn.md +63 -0
- package/write-the-f-paper/workflows/execute-section.md +704 -0
- package/write-the-f-paper/workflows/execute-section.wcn.md +219 -0
- package/write-the-f-paper/workflows/list-assumptions.md +183 -0
- package/write-the-f-paper/workflows/list-assumptions.wcn.md +42 -0
- package/write-the-f-paper/workflows/lit-review-phase.md +281 -0
- package/write-the-f-paper/workflows/lit-review-phase.wcn.md +92 -0
- package/write-the-f-paper/workflows/map-project.md +359 -0
- package/write-the-f-paper/workflows/map-project.wcn.md +73 -0
- package/write-the-f-paper/workflows/plan-section.md +409 -0
- package/write-the-f-paper/workflows/plan-section.wcn.md +236 -0
- package/write-the-f-paper/workflows/research-gap.md +469 -0
- package/write-the-f-paper/workflows/research-gap.wcn.md +119 -0
- package/write-the-f-paper/workflows/resume-paper.md +274 -0
- package/write-the-f-paper/workflows/resume-paper.wcn.md +93 -0
- package/write-the-f-paper/workflows/review-section.md +329 -0
- package/write-the-f-paper/workflows/review-section.wcn.md +91 -0
- package/write-the-f-paper/workflows/submit-draft.md +368 -0
- package/write-the-f-paper/workflows/submit-draft.wcn.md +69 -0
- package/write-the-f-paper/workflows/transition.md +375 -0
- package/write-the-f-paper/workflows/transition.wcn.md +113 -0
|
@@ -0,0 +1,132 @@
|
|
|
1
|
+
<questioning_guide>
|
|
2
|
+
The initialization phase is vision extraction, not requirements gathering. You're helping the researcher discover and articulate their core argument. This isn't a contract negotiation — it's collaborative thinking.
|
|
3
|
+
|
|
4
|
+
<philosophy>
|
|
5
|
+
**You are a thinking partner, not an interviewer.**
|
|
6
|
+
|
|
7
|
+
The researcher often has a fuzzy idea. Your job is to help them sharpen it. Ask questions that make them think "oh, I hadn't considered that angle" or "yes, that's exactly my contribution."
|
|
8
|
+
|
|
9
|
+
Don't interrogate. Collaborate.
|
|
10
|
+
</philosophy>
|
|
11
|
+
|
|
12
|
+
<critical_rule>
|
|
13
|
+
**ALL questions MUST use AskUserQuestion.**
|
|
14
|
+
|
|
15
|
+
Never ask questions inline as plain text. Every exploration question uses the AskUserQuestion tool with thoughtful options that help the researcher articulate their vision.
|
|
16
|
+
|
|
17
|
+
This applies to:
|
|
18
|
+
- Opening questions ("What's the core argument?")
|
|
19
|
+
- Follow-up questions ("You mentioned X — what would that imply?")
|
|
20
|
+
- Sharpening questions ("What's the single key contribution?")
|
|
21
|
+
- Boundary questions ("What's out of scope?")
|
|
22
|
+
- Decision gates ("Ready to proceed?")
|
|
23
|
+
|
|
24
|
+
The AskUserQuestion format helps researchers think by presenting concrete options to react to, rather than facing a blank text field.
|
|
25
|
+
</critical_rule>
|
|
26
|
+
|
|
27
|
+
<conversation_arc>
|
|
28
|
+
**1. Open**
|
|
29
|
+
|
|
30
|
+
Use AskUserQuestion:
|
|
31
|
+
- header: "Core Argument"
|
|
32
|
+
- question: "What is the main argument or contribution of your paper?"
|
|
33
|
+
- options: Contextual starting points if available, otherwise broad categories + "Let me describe it"
|
|
34
|
+
|
|
35
|
+
Let them respond. Then follow up based on what they said.
|
|
36
|
+
|
|
37
|
+
**2. Follow the thread**
|
|
38
|
+
|
|
39
|
+
Whatever they said — dig into it. What's the key insight? What gap does this fill?
|
|
40
|
+
|
|
41
|
+
Use AskUserQuestion with options that probe what they mentioned:
|
|
42
|
+
- header: "[Topic they mentioned]"
|
|
43
|
+
- question: "You mentioned [X] — what's the key insight there?"
|
|
44
|
+
- options: 2-3 interpretations of what they might mean + "Something else"
|
|
45
|
+
|
|
46
|
+
**3. Sharpen the core**
|
|
47
|
+
|
|
48
|
+
Help them distinguish the essential from the nice-to-have.
|
|
49
|
+
|
|
50
|
+
Use AskUserQuestion:
|
|
51
|
+
- header: "Key Contribution"
|
|
52
|
+
- question: "If reviewers remember one thing, what should it be?"
|
|
53
|
+
- options: Key aspects they've mentioned + "The methodology" + "The findings" + "Something else"
|
|
54
|
+
|
|
55
|
+
**4. Find the boundaries**
|
|
56
|
+
|
|
57
|
+
What is this paper NOT about? Explicit exclusions prevent scope creep.
|
|
58
|
+
|
|
59
|
+
Use AskUserQuestion:
|
|
60
|
+
- header: "Scope"
|
|
61
|
+
- question: "What's explicitly NOT in this paper?"
|
|
62
|
+
- options: Tempting tangents + "Nothing specific" + "Let me list them"
|
|
63
|
+
|
|
64
|
+
**5. Ground in reality**
|
|
65
|
+
|
|
66
|
+
Only ask about constraints that actually exist.
|
|
67
|
+
|
|
68
|
+
Use AskUserQuestion:
|
|
69
|
+
- header: "Constraints"
|
|
70
|
+
- question: "Any hard constraints?"
|
|
71
|
+
- options: ["Page/word limit", "Submission deadline", "Data limitations", "None", "Multiple constraints"]
|
|
72
|
+
</conversation_arc>
|
|
73
|
+
|
|
74
|
+
<academic_specific_probes>
|
|
75
|
+
**"It's a contribution to the field"** →
|
|
76
|
+
- header: "Contribution"
|
|
77
|
+
- question: "Contribution how?"
|
|
78
|
+
- options: ["New method", "New findings", "Challenges existing view", "Synthesizes existing work", "Let me describe"]
|
|
79
|
+
|
|
80
|
+
**"It fills a gap"** →
|
|
81
|
+
- header: "Gap"
|
|
82
|
+
- question: "What gap specifically?"
|
|
83
|
+
- options: ["Method gap", "Data gap", "Theory gap", "Application gap", "Let me describe"]
|
|
84
|
+
|
|
85
|
+
**"It's important for practitioners"** →
|
|
86
|
+
- header: "Practical Impact"
|
|
87
|
+
- question: "What would change for practitioners?"
|
|
88
|
+
- options: ["New technique they can use", "Changes how they think", "Saves time/money", "Let me describe"]
|
|
89
|
+
|
|
90
|
+
**Venue targeting:**
|
|
91
|
+
- header: "Target Venue"
|
|
92
|
+
- question: "What's the target venue?"
|
|
93
|
+
- options: [Common venues for their field + "Undecided" + "Let me specify"]
|
|
94
|
+
</academic_specific_probes>
|
|
95
|
+
|
|
96
|
+
<coverage_check>
|
|
97
|
+
By the end of questioning, you should understand:
|
|
98
|
+
|
|
99
|
+
- [ ] What the core argument/contribution is (the thesis)
|
|
100
|
+
- [ ] Why this matters (the significance)
|
|
101
|
+
- [ ] Who the audience is (even if broad field)
|
|
102
|
+
- [ ] What evidence supports it (data, analysis)
|
|
103
|
+
- [ ] What's NOT in scope (boundaries)
|
|
104
|
+
- [ ] Any real constraints (page limits, deadlines)
|
|
105
|
+
- [ ] What exists already (building on prior work?)
|
|
106
|
+
|
|
107
|
+
If gaps remain, weave questions naturally into the conversation.
|
|
108
|
+
</coverage_check>
|
|
109
|
+
|
|
110
|
+
<decision_gate>
|
|
111
|
+
When you feel you understand the vision, use AskUserQuestion:
|
|
112
|
+
|
|
113
|
+
- header: "Ready?"
|
|
114
|
+
- question: "Ready to create PROJECT.md, or explore more?"
|
|
115
|
+
- options (ALL THREE REQUIRED):
|
|
116
|
+
- "Create PROJECT.md" - Finalize and continue
|
|
117
|
+
- "Ask more questions" - I'll dig into areas we haven't covered
|
|
118
|
+
- "Let me add context" - You have more to share
|
|
119
|
+
|
|
120
|
+
Loop until "Create PROJECT.md" selected.
|
|
121
|
+
</decision_gate>
|
|
122
|
+
|
|
123
|
+
<anti_patterns>
|
|
124
|
+
- **Interrogation** - Firing questions without building on answers
|
|
125
|
+
- **Checklist walking** - Going through domains regardless of conversation flow
|
|
126
|
+
- **Academic speak** - "What are your hypotheses?" before understanding the idea
|
|
127
|
+
- **Rushing** - Minimizing questions to get to "the writing"
|
|
128
|
+
- **Assuming** - Filling gaps with assumptions instead of asking
|
|
129
|
+
- **Method-first** - Asking about methodology before understanding the question
|
|
130
|
+
- **Shallow acceptance** - Taking vague answers without probing for specifics
|
|
131
|
+
</anti_patterns>
|
|
132
|
+
</questioning_guide>
|
|
@@ -0,0 +1,208 @@
|
|
|
1
|
+
<research_pitfalls>
|
|
2
|
+
|
|
3
|
+
<purpose>
|
|
4
|
+
This document catalogs literature research mistakes and provides verification strategies for academic writing.
|
|
5
|
+
</purpose>
|
|
6
|
+
|
|
7
|
+
<known_pitfalls>
|
|
8
|
+
|
|
9
|
+
<pitfall_citation_scope>
|
|
10
|
+
**What**: Citing a paper for a claim it doesn't actually make
|
|
11
|
+
**Example**: Citing Smith2023 for "effect size of 0.5" when Smith2023 reports a different study
|
|
12
|
+
**Why it happens**: Relying on secondary sources or memory instead of checking primary source
|
|
13
|
+
**Prevention**:
|
|
14
|
+
```xml
|
|
15
|
+
<verification_checklist>
|
|
16
|
+
**CRITICAL**: For every citation:
|
|
17
|
+
□ Have I read the actual source (not just abstract)?
|
|
18
|
+
□ Does the source actually say what I'm claiming?
|
|
19
|
+
□ Is the page/section reference correct?
|
|
20
|
+
□ Am I citing the original source (not a secondary mention)?
|
|
21
|
+
</verification_checklist>
|
|
22
|
+
```
|
|
23
|
+
</pitfall_citation_scope>
|
|
24
|
+
|
|
25
|
+
<pitfall_outdated_literature>
|
|
26
|
+
**What**: Citing outdated findings that have been superseded
|
|
27
|
+
**Example**: Citing a 2010 meta-analysis when a 2023 one exists with different conclusions
|
|
28
|
+
**Why it happens**: Not checking for recent literature updates
|
|
29
|
+
**Prevention**:
|
|
30
|
+
```xml
|
|
31
|
+
<verification_checklist>
|
|
32
|
+
□ Search for systematic reviews/meta-analyses (most current)
|
|
33
|
+
□ Check citation counts and "cited by" for newer work
|
|
34
|
+
□ Verify no replication failures or corrections exist
|
|
35
|
+
□ Ensure methodology hasn't been superseded
|
|
36
|
+
</verification_checklist>
|
|
37
|
+
```
|
|
38
|
+
</pitfall_outdated_literature>
|
|
39
|
+
|
|
40
|
+
<pitfall_cherry_picking>
|
|
41
|
+
**What**: Only citing sources that support your argument, ignoring contradictory evidence
|
|
42
|
+
**Example**: Claiming "research consistently shows X" while ignoring studies showing not-X
|
|
43
|
+
**Why it happens**: Confirmation bias, incomplete literature search
|
|
44
|
+
**Prevention**:
|
|
45
|
+
```xml
|
|
46
|
+
<verification_checklist>
|
|
47
|
+
□ Search for contradictory evidence explicitly
|
|
48
|
+
□ Check for debate/controversy in the field
|
|
49
|
+
□ Include limitations and alternative interpretations
|
|
50
|
+
□ Acknowledge conflicting findings in Discussion
|
|
51
|
+
</verification_checklist>
|
|
52
|
+
```
|
|
53
|
+
</pitfall_cherry_picking>
|
|
54
|
+
|
|
55
|
+
<pitfall_misattribution>
|
|
56
|
+
**What**: Attributing ideas to wrong sources or claiming originality for existing ideas
|
|
57
|
+
**Example**: Claiming "we are the first to..." when prior work exists
|
|
58
|
+
**Why it happens**: Incomplete literature review
|
|
59
|
+
**Prevention**:
|
|
60
|
+
```xml
|
|
61
|
+
<verification_checklist>
|
|
62
|
+
□ Search for prior work using multiple query formulations
|
|
63
|
+
□ Check key papers' references for relevant prior work
|
|
64
|
+
□ Verify "first" claims with thorough search
|
|
65
|
+
□ When in doubt, phrase as "to our knowledge"
|
|
66
|
+
</verification_checklist>
|
|
67
|
+
```
|
|
68
|
+
</pitfall_misattribution>
|
|
69
|
+
|
|
70
|
+
<pitfall_source_quality>
|
|
71
|
+
**What**: Citing low-quality or non-peer-reviewed sources for empirical claims
|
|
72
|
+
**Example**: Citing a blog post or preprint for established facts
|
|
73
|
+
**Why it happens**: First search result used without quality check
|
|
74
|
+
**Prevention**:
|
|
75
|
+
```xml
|
|
76
|
+
<source_verification>
|
|
77
|
+
For empirical claims:
|
|
78
|
+
- [ ] Peer-reviewed journal (preferred)
|
|
79
|
+
- [ ] Published conference proceedings (acceptable)
|
|
80
|
+
- [ ] Government/institutional reports (for statistics)
|
|
81
|
+
- [ ] Preprints only if noting "not peer-reviewed"
|
|
82
|
+
</source_verification>
|
|
83
|
+
```
|
|
84
|
+
</pitfall_source_quality>
|
|
85
|
+
|
|
86
|
+
<pitfall_false_consensus>
|
|
87
|
+
**What**: Claiming broad consensus when field is actually divided
|
|
88
|
+
**Example**: "It is well established that..." when significant debate exists
|
|
89
|
+
**Why it happens**: Exposure to limited subset of literature
|
|
90
|
+
**Prevention**:
|
|
91
|
+
```xml
|
|
92
|
+
<verification_checklist>
|
|
93
|
+
□ Check for review papers discussing field debates
|
|
94
|
+
□ Search for "critique of X" or "X controversy"
|
|
95
|
+
□ Verify claim with multiple independent sources
|
|
96
|
+
□ Use hedged language if consensus uncertain
|
|
97
|
+
</verification_checklist>
|
|
98
|
+
```
|
|
99
|
+
</pitfall_false_consensus>
|
|
100
|
+
|
|
101
|
+
<pitfall_effect_size_conflation>
|
|
102
|
+
**What**: Confusing statistical significance with practical importance
|
|
103
|
+
**Example**: Citing p < .001 without noting tiny effect size
|
|
104
|
+
**Why it happens**: Focus on p-values over effect sizes
|
|
105
|
+
**Prevention**:
|
|
106
|
+
```xml
|
|
107
|
+
<verification_checklist>
|
|
108
|
+
□ Report effect sizes, not just significance
|
|
109
|
+
□ Check sample size (large samples find tiny effects)
|
|
110
|
+
□ Compare to meaningful benchmarks in field
|
|
111
|
+
□ Note practical vs. statistical significance
|
|
112
|
+
</verification_checklist>
|
|
113
|
+
```
|
|
114
|
+
</pitfall_effect_size_conflation>
|
|
115
|
+
|
|
116
|
+
<pitfall_definitional_drift>
|
|
117
|
+
**What**: Using terms inconsistently or differently from cited sources
|
|
118
|
+
**Example**: Your definition of "resilience" differs from cited paper's definition
|
|
119
|
+
**Why it happens**: Not checking how sources define key terms
|
|
120
|
+
**Prevention**:
|
|
121
|
+
```xml
|
|
122
|
+
<verification_checklist>
|
|
123
|
+
□ Define key terms explicitly in paper
|
|
124
|
+
□ Check cited sources use terms same way
|
|
125
|
+
□ Note when sources use different definitions
|
|
126
|
+
□ Be consistent throughout your paper
|
|
127
|
+
</verification_checklist>
|
|
128
|
+
```
|
|
129
|
+
</pitfall_definitional_drift>
|
|
130
|
+
</known_pitfalls>
|
|
131
|
+
|
|
132
|
+
<red_flags>
|
|
133
|
+
|
|
134
|
+
<red_flag_all_support>
|
|
135
|
+
**Warning**: All cited sources perfectly support your claims
|
|
136
|
+
**Problem**: Real literature has nuance and contradictions
|
|
137
|
+
**Action**: Look harder for alternative viewpoints
|
|
138
|
+
</red_flag_all_support>
|
|
139
|
+
|
|
140
|
+
<red_flag_old_citations>
|
|
141
|
+
**Warning**: Most citations are >5-10 years old in active field
|
|
142
|
+
**Problem**: May be missing recent developments
|
|
143
|
+
**Action**: Update literature search with recent date filters
|
|
144
|
+
</red_flag_old_citations>
|
|
145
|
+
|
|
146
|
+
<red_flag_secondary_citations>
|
|
147
|
+
**Warning**: "Smith (2020) reports that Jones (2018) found..."
|
|
148
|
+
**Problem**: Telephone game introduces errors
|
|
149
|
+
**Action**: Go to primary source (Jones 2018) directly
|
|
150
|
+
</red_flag_secondary_citations>
|
|
151
|
+
|
|
152
|
+
<red_flag_no_limitations>
|
|
153
|
+
**Warning**: No limitations mentioned for cited studies
|
|
154
|
+
**Problem**: All studies have limitations
|
|
155
|
+
**Action**: Note relevant limitations, especially for key claims
|
|
156
|
+
</red_flag_no_limitations>
|
|
157
|
+
|
|
158
|
+
<red_flag_unanimous_field>
|
|
159
|
+
**Warning**: "All researchers agree..." or "The literature clearly shows..."
|
|
160
|
+
**Problem**: Fields rarely have complete consensus
|
|
161
|
+
**Action**: Verify with meta-analyses, check for debates
|
|
162
|
+
</red_flag_unanimous_field>
|
|
163
|
+
</red_flags>
|
|
164
|
+
|
|
165
|
+
<literature_search_best_practices>
|
|
166
|
+
|
|
167
|
+
**1. Use multiple databases:**
|
|
168
|
+
- Google Scholar (broad)
|
|
169
|
+
- Field-specific databases (PubMed, PsycINFO, etc.)
|
|
170
|
+
- Citation tracking (forward and backward)
|
|
171
|
+
|
|
172
|
+
**2. Use multiple query formulations:**
|
|
173
|
+
- Synonyms and related terms
|
|
174
|
+
- Different orderings
|
|
175
|
+
- Include/exclude specific contexts
|
|
176
|
+
|
|
177
|
+
**3. Check "cited by" for key papers:**
|
|
178
|
+
- Finds newer work building on foundations
|
|
179
|
+
- Reveals debates and critiques
|
|
180
|
+
|
|
181
|
+
**4. Read abstracts critically:**
|
|
182
|
+
- Distinguish methods, findings, interpretations
|
|
183
|
+
- Note sample sizes and contexts
|
|
184
|
+
|
|
185
|
+
**5. Maintain bibliography as you go:**
|
|
186
|
+
- Update sources/literature.md continuously
|
|
187
|
+
- Note relevance and key quotes
|
|
188
|
+
- Track what you've actually read vs. skimmed
|
|
189
|
+
</literature_search_best_practices>
|
|
190
|
+
|
|
191
|
+
<quick_reference>
|
|
192
|
+
|
|
193
|
+
Before finalizing citations, verify:
|
|
194
|
+
|
|
195
|
+
- [ ] Primary source actually read (not just abstract)
|
|
196
|
+
- [ ] Claim accurately reflects source's findings
|
|
197
|
+
- [ ] No newer work supersedes this finding
|
|
198
|
+
- [ ] Contradictory evidence acknowledged
|
|
199
|
+
- [ ] Source quality appropriate for claim type
|
|
200
|
+
- [ ] Key terms used consistently with sources
|
|
201
|
+
- [ ] Effect sizes reported where relevant
|
|
202
|
+
- [ ] Consensus claims verified with multiple sources
|
|
203
|
+
- [ ] "First to" claims thoroughly searched
|
|
204
|
+
- [ ] All references formatted correctly
|
|
205
|
+
|
|
206
|
+
**Living Document**: Update after each citation error discovered
|
|
207
|
+
</quick_reference>
|
|
208
|
+
</research_pitfalls>
|
|
@@ -0,0 +1,30 @@
|
|
|
1
|
+
{
|
|
2
|
+
"mode": "interactive",
|
|
3
|
+
"depth": "standard",
|
|
4
|
+
"document_type": "paper",
|
|
5
|
+
"output_format": "markdown",
|
|
6
|
+
"gates": {
|
|
7
|
+
"confirm_project": true,
|
|
8
|
+
"confirm_sections": true,
|
|
9
|
+
"confirm_roadmap": true,
|
|
10
|
+
"confirm_outline": true,
|
|
11
|
+
"confirm_plan": true,
|
|
12
|
+
"write_next_plan": true,
|
|
13
|
+
"issues_review": true,
|
|
14
|
+
"confirm_transition": true
|
|
15
|
+
},
|
|
16
|
+
"writing": {
|
|
17
|
+
"claude_mode": "co-author",
|
|
18
|
+
"citation_style": "apa",
|
|
19
|
+
"verify_on_complete": true
|
|
20
|
+
},
|
|
21
|
+
"verification": {
|
|
22
|
+
"citation_check": true,
|
|
23
|
+
"coherence_check": true,
|
|
24
|
+
"rubric_check": true
|
|
25
|
+
},
|
|
26
|
+
"safety": {
|
|
27
|
+
"always_confirm_destructive": true,
|
|
28
|
+
"backup_before_major_edits": true
|
|
29
|
+
}
|
|
30
|
+
}
|
|
@@ -0,0 +1,179 @@
|
|
|
1
|
+
# Section Context Template
|
|
2
|
+
|
|
3
|
+
Template for `.planning/sections/XX-name/{section}-CONTEXT.md` - captures the user's vision for a section.
|
|
4
|
+
|
|
5
|
+
**Purpose:** Document how the user imagines the section working. This is vision context, not technical analysis. Research details come from the research workflow.
|
|
6
|
+
|
|
7
|
+
---
|
|
8
|
+
|
|
9
|
+
## File Template
|
|
10
|
+
|
|
11
|
+
```markdown
|
|
12
|
+
# Section [X]: [Name] - Context
|
|
13
|
+
|
|
14
|
+
**Gathered:** [date]
|
|
15
|
+
**Status:** [Ready for research / Ready for planning]
|
|
16
|
+
|
|
17
|
+
<vision>
|
|
18
|
+
## How This Section Should Work
|
|
19
|
+
|
|
20
|
+
[User's description of how they imagine this section functioning for the reader. What should the reader understand after reading it? What's the "story" of this section? This is the "pitch" version, not the detailed outline.]
|
|
21
|
+
|
|
22
|
+
</vision>
|
|
23
|
+
|
|
24
|
+
<essential>
|
|
25
|
+
## What Must Be Nailed
|
|
26
|
+
|
|
27
|
+
[The core of this section. If we only get one thing right, what is it? What's the non-negotiable that makes this section successful?]
|
|
28
|
+
|
|
29
|
+
- [Essential thing 1]
|
|
30
|
+
- [Essential thing 2]
|
|
31
|
+
- [Essential thing 3 if applicable]
|
|
32
|
+
|
|
33
|
+
</essential>
|
|
34
|
+
|
|
35
|
+
<boundaries>
|
|
36
|
+
## What's Out of Scope
|
|
37
|
+
|
|
38
|
+
[Explicit exclusions for this section. What are we NOT covering? Where does this section end and the next begin?]
|
|
39
|
+
|
|
40
|
+
- [Not covering X - that's Section Y]
|
|
41
|
+
- [Not including Z - deferred to future work]
|
|
42
|
+
- [Explicitly excluding W]
|
|
43
|
+
|
|
44
|
+
</boundaries>
|
|
45
|
+
|
|
46
|
+
<specifics>
|
|
47
|
+
## Specific Ideas
|
|
48
|
+
|
|
49
|
+
[Any particular things the user has in mind. References to papers they like. Specific arguments or evidence to include. "I want it to flow like X paper" or "The key evidence is Y."]
|
|
50
|
+
|
|
51
|
+
[If none: "No specific requirements - open to standard approaches"]
|
|
52
|
+
|
|
53
|
+
</specifics>
|
|
54
|
+
|
|
55
|
+
<sources>
|
|
56
|
+
## Available Sources
|
|
57
|
+
|
|
58
|
+
[What material the user has available for this section]
|
|
59
|
+
|
|
60
|
+
- Literature: [Key papers to cite]
|
|
61
|
+
- Data: [Figures, tables, statistics available]
|
|
62
|
+
- Prior drafts: [Existing text to incorporate]
|
|
63
|
+
|
|
64
|
+
</sources>
|
|
65
|
+
|
|
66
|
+
<notes>
|
|
67
|
+
## Additional Context
|
|
68
|
+
|
|
69
|
+
[Anything else captured during the discussion that doesn't fit above. User's priorities, concerns mentioned, relevant background.]
|
|
70
|
+
|
|
71
|
+
[If none: "No additional notes"]
|
|
72
|
+
|
|
73
|
+
</notes>
|
|
74
|
+
|
|
75
|
+
---
|
|
76
|
+
|
|
77
|
+
*Section: XX-name*
|
|
78
|
+
*Context gathered: [date]*
|
|
79
|
+
```
|
|
80
|
+
|
|
81
|
+
<good_examples>
|
|
82
|
+
```markdown
|
|
83
|
+
# Section 3: Methods - Context
|
|
84
|
+
|
|
85
|
+
**Gathered:** 2025-01-20
|
|
86
|
+
**Status:** Ready for research
|
|
87
|
+
|
|
88
|
+
<vision>
|
|
89
|
+
## How This Section Should Work
|
|
90
|
+
|
|
91
|
+
When reviewers read this methods section, they should feel confident they could replicate the study. I want it to feel rigorous but not tedious - every detail should earn its place. The flow should be: who participated, what they did, and how we analyzed it.
|
|
92
|
+
|
|
93
|
+
The section should anticipate reviewer questions about validity and address them preemptively.
|
|
94
|
+
|
|
95
|
+
</vision>
|
|
96
|
+
|
|
97
|
+
<essential>
|
|
98
|
+
## What Must Be Nailed
|
|
99
|
+
|
|
100
|
+
- **Reproducibility** - Someone could replicate this study from the methods alone
|
|
101
|
+
- **Validity** - Address potential confounds and how we controlled for them
|
|
102
|
+
- **Ethical compliance** - IRB approval and participant consent clear
|
|
103
|
+
|
|
104
|
+
</essential>
|
|
105
|
+
|
|
106
|
+
<boundaries>
|
|
107
|
+
## What's Out of Scope
|
|
108
|
+
|
|
109
|
+
- Detailed results (just analysis approach here)
|
|
110
|
+
- Extended rationale for method choices (brief is fine)
|
|
111
|
+
- Preliminary/pilot study details (not relevant)
|
|
112
|
+
|
|
113
|
+
</boundaries>
|
|
114
|
+
|
|
115
|
+
<specifics>
|
|
116
|
+
## Specific Ideas
|
|
117
|
+
|
|
118
|
+
- I like how Smith (2023) structured their participant section - demographics first, then inclusion criteria
|
|
119
|
+
- We should include the exact prompt text used (reviewer always asks)
|
|
120
|
+
- The analysis follows Cohen's framework - cite appropriately
|
|
121
|
+
|
|
122
|
+
</specifics>
|
|
123
|
+
|
|
124
|
+
<sources>
|
|
125
|
+
## Available Sources
|
|
126
|
+
|
|
127
|
+
- Literature: Cohen (2020) for analysis framework, Smith (2023) for structure example
|
|
128
|
+
- Data: Participant demographics table ready, Figure 2 (study flow) ready
|
|
129
|
+
- Prior drafts: Had a rough methods draft in proposal - reusable but needs expansion
|
|
130
|
+
|
|
131
|
+
</sources>
|
|
132
|
+
|
|
133
|
+
<notes>
|
|
134
|
+
## Additional Context
|
|
135
|
+
|
|
136
|
+
User is worried reviewers will question the sample size (N=45). Need to address power analysis or limitation. Also mentioned that the IRB number is #2024-0123 (needs to appear in text).
|
|
137
|
+
|
|
138
|
+
</notes>
|
|
139
|
+
|
|
140
|
+
---
|
|
141
|
+
|
|
142
|
+
*Section: 03-methods*
|
|
143
|
+
*Context gathered: 2025-01-20*
|
|
144
|
+
```
|
|
145
|
+
</good_examples>
|
|
146
|
+
|
|
147
|
+
<guidelines>
|
|
148
|
+
**This template captures VISION, not detailed outlines.**
|
|
149
|
+
|
|
150
|
+
The user is the visionary. They know:
|
|
151
|
+
- How they imagine the section working for readers
|
|
152
|
+
- What it should accomplish
|
|
153
|
+
- What's essential vs nice-to-have
|
|
154
|
+
- References to papers they like
|
|
155
|
+
- Sources they have available
|
|
156
|
+
|
|
157
|
+
The user does NOT know (and shouldn't be asked):
|
|
158
|
+
- Exact paragraph structure (Claude figures out during planning)
|
|
159
|
+
- Citation formatting (Claude handles)
|
|
160
|
+
- Transitions between paragraphs (Claude writes)
|
|
161
|
+
- Word allocation within section (Claude calculates)
|
|
162
|
+
|
|
163
|
+
**Content should read like:**
|
|
164
|
+
- A researcher describing what they want the section to do
|
|
165
|
+
- "When readers finish this section, they should understand..."
|
|
166
|
+
- "The most important thing to convey is..."
|
|
167
|
+
- "I want this to feel like Smith's methods, not Jones's"
|
|
168
|
+
|
|
169
|
+
**Content should NOT read like:**
|
|
170
|
+
- A paragraph-by-paragraph outline
|
|
171
|
+
- A list of citations to include
|
|
172
|
+
- Word count targets
|
|
173
|
+
- Detailed structure
|
|
174
|
+
|
|
175
|
+
**After creation:**
|
|
176
|
+
- File lives in section directory: `.planning/sections/XX-name/{section}-CONTEXT.md`
|
|
177
|
+
- Research phase adds investigation results if needed
|
|
178
|
+
- Planning phase creates executable tasks informed by both vision AND research
|
|
179
|
+
</guidelines>
|
|
@@ -0,0 +1,142 @@
|
|
|
1
|
+
# Continue-Here Template
|
|
2
|
+
|
|
3
|
+
Copy and fill this structure for `.planning/sections/XX-name/.continue-here.md`:
|
|
4
|
+
|
|
5
|
+
```yaml
|
|
6
|
+
---
|
|
7
|
+
section: XX-name
|
|
8
|
+
task: 3
|
|
9
|
+
total_tasks: 7
|
|
10
|
+
status: in_progress
|
|
11
|
+
last_updated: 2025-01-15T14:30:00Z
|
|
12
|
+
---
|
|
13
|
+
```
|
|
14
|
+
|
|
15
|
+
```markdown
|
|
16
|
+
<current_state>
|
|
17
|
+
[Where exactly are we in the writing? What's the immediate context?]
|
|
18
|
+
</current_state>
|
|
19
|
+
|
|
20
|
+
<completed_work>
|
|
21
|
+
[What got written this session - be specific]
|
|
22
|
+
|
|
23
|
+
- Task 1: [name] - Done
|
|
24
|
+
- Task 2: [name] - Done
|
|
25
|
+
- Task 3: [name] - In progress, [what's done on it]
|
|
26
|
+
</completed_work>
|
|
27
|
+
|
|
28
|
+
<remaining_work>
|
|
29
|
+
[What's left in this section]
|
|
30
|
+
|
|
31
|
+
- Task 3: [name] - [what's left to write]
|
|
32
|
+
- Task 4: [name] - Not started
|
|
33
|
+
- Task 5: [name] - Not started
|
|
34
|
+
</remaining_work>
|
|
35
|
+
|
|
36
|
+
<decisions_made>
|
|
37
|
+
[Key decisions and why - so next session doesn't re-debate]
|
|
38
|
+
|
|
39
|
+
- Decided to use [X] framing because [reason]
|
|
40
|
+
- Chose [approach] over [alternative] because [reason]
|
|
41
|
+
</decisions_made>
|
|
42
|
+
|
|
43
|
+
<word_count>
|
|
44
|
+
Current: [X] words written
|
|
45
|
+
Target: [Y] words for section
|
|
46
|
+
Remaining budget: [Z] words
|
|
47
|
+
</word_count>
|
|
48
|
+
|
|
49
|
+
<blockers>
|
|
50
|
+
[Anything stuck or waiting on external factors]
|
|
51
|
+
|
|
52
|
+
- [Blocker 1]: [status/workaround]
|
|
53
|
+
</blockers>
|
|
54
|
+
|
|
55
|
+
<context>
|
|
56
|
+
[Mental state, "vibe", anything that helps resume smoothly]
|
|
57
|
+
|
|
58
|
+
[What were you thinking about? What was the plan?
|
|
59
|
+
This is the "pick up exactly where you left off" context.]
|
|
60
|
+
</context>
|
|
61
|
+
|
|
62
|
+
<next_action>
|
|
63
|
+
[The very first thing to do when resuming]
|
|
64
|
+
|
|
65
|
+
Start with: [specific action]
|
|
66
|
+
</next_action>
|
|
67
|
+
```
|
|
68
|
+
|
|
69
|
+
<yaml_fields>
|
|
70
|
+
Required YAML frontmatter:
|
|
71
|
+
|
|
72
|
+
- `section`: Directory name (e.g., `02-methods`)
|
|
73
|
+
- `task`: Current task number
|
|
74
|
+
- `total_tasks`: How many tasks in section
|
|
75
|
+
- `status`: `in_progress`, `blocked`, `almost_done`
|
|
76
|
+
- `last_updated`: ISO timestamp
|
|
77
|
+
</yaml_fields>
|
|
78
|
+
|
|
79
|
+
<guidelines>
|
|
80
|
+
- Be specific enough that a fresh Claude instance understands immediately
|
|
81
|
+
- Include WHY decisions were made, not just what
|
|
82
|
+
- Include word count progress so next session knows budget
|
|
83
|
+
- The `<next_action>` should be actionable without reading anything else
|
|
84
|
+
- This file gets DELETED after resume - it's not permanent storage
|
|
85
|
+
</guidelines>
|
|
86
|
+
|
|
87
|
+
<example>
|
|
88
|
+
```yaml
|
|
89
|
+
---
|
|
90
|
+
section: 03-methods
|
|
91
|
+
task: 4
|
|
92
|
+
total_tasks: 6
|
|
93
|
+
status: in_progress
|
|
94
|
+
last_updated: 2025-01-20T16:45:00Z
|
|
95
|
+
---
|
|
96
|
+
```
|
|
97
|
+
|
|
98
|
+
```markdown
|
|
99
|
+
<current_state>
|
|
100
|
+
Writing the Analysis subsection of Methods. Just finished the Measures subsection. Have participant demographics and procedures done.
|
|
101
|
+
</current_state>
|
|
102
|
+
|
|
103
|
+
<completed_work>
|
|
104
|
+
- Task 1: Participants subsection - Done (demographics, N=45, inclusion criteria)
|
|
105
|
+
- Task 2: Procedures subsection - Done (study flow, timing, conditions)
|
|
106
|
+
- Task 3: Measures subsection - Done (all instruments described with citations)
|
|
107
|
+
- Task 4: Analysis subsection - In progress, wrote intro paragraph about approach
|
|
108
|
+
</completed_work>
|
|
109
|
+
|
|
110
|
+
<remaining_work>
|
|
111
|
+
- Task 4: Analysis - Need to describe specific statistical tests and software
|
|
112
|
+
- Task 5: Ethical considerations - IRB statement, consent process
|
|
113
|
+
- Task 6: Final polish - Transitions, word count trimming
|
|
114
|
+
</remaining_work>
|
|
115
|
+
|
|
116
|
+
<decisions_made>
|
|
117
|
+
- Used Cohen (2020) framework for analysis - matches prior literature
|
|
118
|
+
- Decided NOT to include power analysis in main text (will add to supplementary if reviewers ask)
|
|
119
|
+
- Put measures before analysis (reviewer suggested this order)
|
|
120
|
+
</decisions_made>
|
|
121
|
+
|
|
122
|
+
<word_count>
|
|
123
|
+
Current: 892 words written
|
|
124
|
+
Target: 1200 words for section
|
|
125
|
+
Remaining budget: 308 words
|
|
126
|
+
</word_count>
|
|
127
|
+
|
|
128
|
+
<blockers>
|
|
129
|
+
None currently
|
|
130
|
+
</blockers>
|
|
131
|
+
|
|
132
|
+
<context>
|
|
133
|
+
The analysis section needs to justify N=45 indirectly through effect size discussion. Main worry is reviewer pushback on sample size. Tone should be confident but not dismissive of limitation.
|
|
134
|
+
|
|
135
|
+
Planning to use "Following Cohen (2020), we employed..." structure for consistency.
|
|
136
|
+
</context>
|
|
137
|
+
|
|
138
|
+
<next_action>
|
|
139
|
+
Start with: Continue Task 4 - write the specific statistical tests paragraph (t-tests for group comparisons, regression for predictors)
|
|
140
|
+
</next_action>
|
|
141
|
+
```
|
|
142
|
+
</example>
|