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,267 @@
|
|
|
1
|
+
# Argument Structure Template
|
|
2
|
+
|
|
3
|
+
Template for `.planning/structure/argument-map.md` — the logical structure of your paper.
|
|
4
|
+
|
|
5
|
+
**Purpose:** Map the logical flow from claims to evidence to conclusions. This is the "skeleton" of your argument that all writing builds upon.
|
|
6
|
+
|
|
7
|
+
---
|
|
8
|
+
|
|
9
|
+
## File Template
|
|
10
|
+
|
|
11
|
+
```markdown
|
|
12
|
+
# Argument Map
|
|
13
|
+
|
|
14
|
+
**Created:** [date]
|
|
15
|
+
**Last updated:** [date]
|
|
16
|
+
|
|
17
|
+
## Central Thesis
|
|
18
|
+
|
|
19
|
+
[The main claim of the paper in one sentence. This is what the entire paper argues for.]
|
|
20
|
+
|
|
21
|
+
## Supporting Claims
|
|
22
|
+
|
|
23
|
+
### Claim 1: [Statement]
|
|
24
|
+
|
|
25
|
+
**What we assert:** [Clear statement of the claim]
|
|
26
|
+
**Evidence:**
|
|
27
|
+
- [Evidence type: empirical/theoretical/logical]
|
|
28
|
+
- [Specific evidence: data, citation, reasoning]
|
|
29
|
+
**Source:** [Citation or "our data/analysis"]
|
|
30
|
+
**Strength:** [Strong / Moderate / Weak]
|
|
31
|
+
**Location:** [Which section presents this]
|
|
32
|
+
|
|
33
|
+
### Claim 2: [Statement]
|
|
34
|
+
|
|
35
|
+
**What we assert:** [Clear statement of the claim]
|
|
36
|
+
**Evidence:**
|
|
37
|
+
- [Evidence type]
|
|
38
|
+
- [Specific evidence]
|
|
39
|
+
**Source:** [Citation or source]
|
|
40
|
+
**Strength:** [Strong / Moderate / Weak]
|
|
41
|
+
**Location:** [Which section presents this]
|
|
42
|
+
|
|
43
|
+
### Claim 3: [Statement]
|
|
44
|
+
|
|
45
|
+
**What we assert:** [Clear statement of the claim]
|
|
46
|
+
**Evidence:**
|
|
47
|
+
- [Evidence type]
|
|
48
|
+
- [Specific evidence]
|
|
49
|
+
**Source:** [Citation or source]
|
|
50
|
+
**Strength:** [Strong / Moderate / Weak]
|
|
51
|
+
**Location:** [Which section presents this]
|
|
52
|
+
|
|
53
|
+
[Continue for all major claims...]
|
|
54
|
+
|
|
55
|
+
## Logical Flow
|
|
56
|
+
|
|
57
|
+
```
|
|
58
|
+
Claim 1 + Claim 2
|
|
59
|
+
↓
|
|
60
|
+
[Intermediate Conclusion 1]
|
|
61
|
+
+
|
|
62
|
+
Claim 3
|
|
63
|
+
↓
|
|
64
|
+
[Intermediate Conclusion 2]
|
|
65
|
+
+
|
|
66
|
+
Claim 4
|
|
67
|
+
↓
|
|
68
|
+
[Central Thesis]
|
|
69
|
+
```
|
|
70
|
+
|
|
71
|
+
## Counterarguments
|
|
72
|
+
|
|
73
|
+
### Objection 1: [Statement]
|
|
74
|
+
|
|
75
|
+
**What critics might say:** [The objection]
|
|
76
|
+
**Why it matters:** [Why we need to address it]
|
|
77
|
+
**Our response:** [How we address it]
|
|
78
|
+
**Placement:** [Where in paper we handle this]
|
|
79
|
+
|
|
80
|
+
### Objection 2: [Statement]
|
|
81
|
+
|
|
82
|
+
**What critics might say:** [The objection]
|
|
83
|
+
**Why it matters:** [Why we need to address it]
|
|
84
|
+
**Our response:** [How we address it]
|
|
85
|
+
**Placement:** [Where in paper we handle this]
|
|
86
|
+
|
|
87
|
+
## Gaps and Weaknesses
|
|
88
|
+
|
|
89
|
+
### Identified Gaps
|
|
90
|
+
|
|
91
|
+
[Claims that need stronger evidence or acknowledgment as limitations]
|
|
92
|
+
|
|
93
|
+
- **Gap 1:** [Claim X lacks sufficient evidence]
|
|
94
|
+
- Current state: [What we have]
|
|
95
|
+
- Needed: [What would strengthen it]
|
|
96
|
+
- Plan: [How to address or acknowledge]
|
|
97
|
+
|
|
98
|
+
- **Gap 2:** [Logical leap between X and Y]
|
|
99
|
+
- Current state: [The jump we're making]
|
|
100
|
+
- Needed: [Bridging argument or evidence]
|
|
101
|
+
- Plan: [How to address]
|
|
102
|
+
|
|
103
|
+
### Acknowledged Limitations
|
|
104
|
+
|
|
105
|
+
[Things we're explicitly acknowledging as limitations rather than fixing]
|
|
106
|
+
|
|
107
|
+
- [Limitation 1]: Acknowledged in [section]
|
|
108
|
+
- [Limitation 2]: Acknowledged in [section]
|
|
109
|
+
|
|
110
|
+
## Claim-Section Mapping
|
|
111
|
+
|
|
112
|
+
| Claim | Primary Section | Supporting Sections |
|
|
113
|
+
|-------|-----------------|---------------------|
|
|
114
|
+
| Claim 1 | Introduction | Methods |
|
|
115
|
+
| Claim 2 | Results | Discussion |
|
|
116
|
+
| Claim 3 | Discussion | Conclusion |
|
|
117
|
+
| Thesis | Abstract, Conclusion | Throughout |
|
|
118
|
+
|
|
119
|
+
---
|
|
120
|
+
|
|
121
|
+
*Argument map for: [Paper title]*
|
|
122
|
+
*Update when argument structure changes*
|
|
123
|
+
```
|
|
124
|
+
|
|
125
|
+
<guidelines>
|
|
126
|
+
|
|
127
|
+
**What belongs in argument-map.md:**
|
|
128
|
+
- The central thesis statement
|
|
129
|
+
- All major claims that support the thesis
|
|
130
|
+
- Evidence for each claim (type and specifics)
|
|
131
|
+
- Logical flow connecting claims to thesis
|
|
132
|
+
- Counterarguments and how you address them
|
|
133
|
+
- Gaps that need attention
|
|
134
|
+
|
|
135
|
+
**What does NOT belong here:**
|
|
136
|
+
- Full prose (that's the paper itself)
|
|
137
|
+
- Detailed citations (just key references)
|
|
138
|
+
- Section outlines (that's outline.md)
|
|
139
|
+
- Narrative structure (that's narrative-arc.md)
|
|
140
|
+
|
|
141
|
+
**When to create:**
|
|
142
|
+
- During project initialization
|
|
143
|
+
- After initial literature review
|
|
144
|
+
- Before detailed section planning
|
|
145
|
+
|
|
146
|
+
**When to update:**
|
|
147
|
+
- When claims change during writing
|
|
148
|
+
- When new evidence is added
|
|
149
|
+
- When counterarguments are identified
|
|
150
|
+
- After major revision
|
|
151
|
+
|
|
152
|
+
**Claim strength assessment:**
|
|
153
|
+
- Strong: Multiple independent sources, robust evidence
|
|
154
|
+
- Moderate: Good evidence but could be challenged
|
|
155
|
+
- Weak: Needs more support, acknowledged as limitation
|
|
156
|
+
|
|
157
|
+
**Usage in workflows:**
|
|
158
|
+
- plan-section loads this for context
|
|
159
|
+
- write-section checks claims against this
|
|
160
|
+
- review-section verifies coherence with this
|
|
161
|
+
</guidelines>
|
|
162
|
+
|
|
163
|
+
<example>
|
|
164
|
+
```markdown
|
|
165
|
+
# Argument Map
|
|
166
|
+
|
|
167
|
+
**Created:** 2025-01-15
|
|
168
|
+
**Last updated:** 2025-01-20
|
|
169
|
+
|
|
170
|
+
## Central Thesis
|
|
171
|
+
|
|
172
|
+
AI-assisted writing tools require discipline-specific frameworks to be effectively adopted in academic research contexts.
|
|
173
|
+
|
|
174
|
+
## Supporting Claims
|
|
175
|
+
|
|
176
|
+
### Claim 1: AI writing tools are proliferating rapidly
|
|
177
|
+
|
|
178
|
+
**What we assert:** The number and sophistication of AI writing tools has grown exponentially since 2022
|
|
179
|
+
**Evidence:**
|
|
180
|
+
- Empirical: Survey data showing 300% increase in tool availability (Smith, 2023)
|
|
181
|
+
- Empirical: Usage statistics from major platforms (Jones, 2024)
|
|
182
|
+
**Source:** Smith (2023), Jones (2024)
|
|
183
|
+
**Strength:** Strong
|
|
184
|
+
**Location:** Introduction (context)
|
|
185
|
+
|
|
186
|
+
### Claim 2: Current adoption in academia is ad hoc
|
|
187
|
+
|
|
188
|
+
**What we assert:** Researchers use AI tools inconsistently and without systematic guidance
|
|
189
|
+
**Evidence:**
|
|
190
|
+
- Empirical: Interview data with 45 researchers
|
|
191
|
+
- Empirical: Survey showing 78% report "trial and error" approach
|
|
192
|
+
**Source:** Our study
|
|
193
|
+
**Strength:** Moderate (single study)
|
|
194
|
+
**Location:** Results
|
|
195
|
+
|
|
196
|
+
### Claim 3: Academic writing has unique constraints not addressed by general tools
|
|
197
|
+
|
|
198
|
+
**What we assert:** Academic writing requires citation integration, argument rigor, and disciplinary conventions that general AI tools don't support
|
|
199
|
+
**Evidence:**
|
|
200
|
+
- Theoretical: Analysis of academic writing requirements (Author, 2022)
|
|
201
|
+
- Logical: Comparison of tool features vs. academic needs
|
|
202
|
+
**Source:** Author (2022), our analysis
|
|
203
|
+
**Strength:** Strong
|
|
204
|
+
**Location:** Literature Review, Discussion
|
|
205
|
+
|
|
206
|
+
### Claim 4: A framework improves adoption and outcomes
|
|
207
|
+
|
|
208
|
+
**What we assert:** Structured guidance leads to more effective and ethical AI tool use
|
|
209
|
+
**Evidence:**
|
|
210
|
+
- Empirical: Pilot study with framework (N=20) vs. control
|
|
211
|
+
- Theoretical: Draws on pedagogical framework literature
|
|
212
|
+
**Source:** Our pilot data
|
|
213
|
+
**Strength:** Moderate (small pilot)
|
|
214
|
+
**Location:** Results, Discussion
|
|
215
|
+
|
|
216
|
+
## Logical Flow
|
|
217
|
+
|
|
218
|
+
```
|
|
219
|
+
Claim 1 (tools proliferating) + Claim 2 (adoption is ad hoc)
|
|
220
|
+
↓
|
|
221
|
+
[Current state is suboptimal]
|
|
222
|
+
+
|
|
223
|
+
Claim 3 (academic writing has unique needs)
|
|
224
|
+
↓
|
|
225
|
+
[General tools don't meet academic needs]
|
|
226
|
+
+
|
|
227
|
+
Claim 4 (framework improves outcomes)
|
|
228
|
+
↓
|
|
229
|
+
[THESIS: Discipline-specific frameworks needed]
|
|
230
|
+
```
|
|
231
|
+
|
|
232
|
+
## Counterarguments
|
|
233
|
+
|
|
234
|
+
### Objection 1: AI writing is cheating
|
|
235
|
+
|
|
236
|
+
**What critics might say:** Using AI tools in academic writing constitutes plagiarism or academic dishonesty
|
|
237
|
+
**Why it matters:** Common concern that blocks adoption
|
|
238
|
+
**Our response:** Distinguish co-authorship from replacement; framework emphasizes transparency
|
|
239
|
+
**Placement:** Discussion (Ethics subsection)
|
|
240
|
+
|
|
241
|
+
### Objection 2: One framework can't fit all disciplines
|
|
242
|
+
|
|
243
|
+
**What critics might say:** Different fields have such different norms that a single framework is too general
|
|
244
|
+
**Why it matters:** Threatens generalizability of contribution
|
|
245
|
+
**Our response:** Framework is adaptable; we demonstrate with two disciplines
|
|
246
|
+
**Placement:** Discussion (Limitations)
|
|
247
|
+
|
|
248
|
+
## Gaps and Weaknesses
|
|
249
|
+
|
|
250
|
+
### Identified Gaps
|
|
251
|
+
|
|
252
|
+
- **Gap 1:** Claim 4 rests on small pilot (N=20)
|
|
253
|
+
- Current state: Promising but preliminary results
|
|
254
|
+
- Needed: Larger validation study
|
|
255
|
+
- Plan: Acknowledge as limitation, note as future work
|
|
256
|
+
|
|
257
|
+
### Acknowledged Limitations
|
|
258
|
+
|
|
259
|
+
- Sample size for pilot: Acknowledged in Discussion
|
|
260
|
+
- Two disciplines only: Acknowledged in Limitations
|
|
261
|
+
|
|
262
|
+
---
|
|
263
|
+
|
|
264
|
+
*Argument map for: AI-Assisted Writing Framework*
|
|
265
|
+
*Update when argument structure changes*
|
|
266
|
+
```
|
|
267
|
+
</example>
|
|
@@ -0,0 +1,152 @@
|
|
|
1
|
+
# Bibliography Template
|
|
2
|
+
|
|
3
|
+
Template for `.planning/sources/literature.md` — the literature index for your paper.
|
|
4
|
+
|
|
5
|
+
**Purpose:** Track all sources: what you must cite, what informed your thinking, and what you still need to find.
|
|
6
|
+
|
|
7
|
+
---
|
|
8
|
+
|
|
9
|
+
## File Template
|
|
10
|
+
|
|
11
|
+
```markdown
|
|
12
|
+
# Literature Index
|
|
13
|
+
|
|
14
|
+
**Created:** [date]
|
|
15
|
+
**Last updated:** [date]
|
|
16
|
+
**Total citations:** [N] core + [M] supporting
|
|
17
|
+
|
|
18
|
+
## Core References (Must Cite)
|
|
19
|
+
|
|
20
|
+
These are foundational works that must appear in the paper.
|
|
21
|
+
|
|
22
|
+
| Key | Citation | Relevance | Section | Status |
|
|
23
|
+
|-----|----------|-----------|---------|--------|
|
|
24
|
+
| smith2023 | Smith, J., et al. (2023). Title. *Journal*, Vol(Issue), pp. DOI | [Why foundational] | Intro | ✓ cited |
|
|
25
|
+
| jones2024 | Jones, A. (2024). Title. *Journal*, Vol(Issue), pp. DOI | [Why foundational] | Methods | ✓ cited |
|
|
26
|
+
| author2022 | Author, B. (2022). Title. *Journal*, Vol(Issue), pp. DOI | [Why foundational] | Lit Review | pending |
|
|
27
|
+
|
|
28
|
+
## Supporting References
|
|
29
|
+
|
|
30
|
+
These provide additional support or context.
|
|
31
|
+
|
|
32
|
+
| Key | Citation | Relevance | Section | Status |
|
|
33
|
+
|-----|----------|-----------|---------|--------|
|
|
34
|
+
| davis2023 | Davis, C., et al. (2023). Title. *Conference Proceedings*. | [What it contributes] | Discussion | optional |
|
|
35
|
+
| miller2024 | Miller, D. (2024). Title. *Journal*. | [What it contributes] | Background | pending |
|
|
36
|
+
|
|
37
|
+
## Background Reading
|
|
38
|
+
|
|
39
|
+
Informed your thinking but may not be directly cited.
|
|
40
|
+
|
|
41
|
+
| Key | Citation | Notes |
|
|
42
|
+
|-----|----------|-------|
|
|
43
|
+
| textbook2020 | Author (2020). *Textbook Title*. Publisher. | Foundational concepts |
|
|
44
|
+
| review2023 | Author (2023). Review article title. | Field overview |
|
|
45
|
+
|
|
46
|
+
## To Find
|
|
47
|
+
|
|
48
|
+
Citations you need but haven't located yet.
|
|
49
|
+
|
|
50
|
+
- [ ] [Description of needed citation] — for [which claim/section]
|
|
51
|
+
- [ ] [Description of needed citation] — for [which claim/section]
|
|
52
|
+
- [ ] [Description of needed citation] — for [which claim/section]
|
|
53
|
+
|
|
54
|
+
## By Section
|
|
55
|
+
|
|
56
|
+
Quick reference for which citations go where.
|
|
57
|
+
|
|
58
|
+
### Introduction
|
|
59
|
+
- smith2023: Context on AI tool proliferation
|
|
60
|
+
- jones2024: Current usage patterns
|
|
61
|
+
|
|
62
|
+
### Literature Review
|
|
63
|
+
- author2022: Academic writing constraints
|
|
64
|
+
- [...]
|
|
65
|
+
|
|
66
|
+
### Methods
|
|
67
|
+
- framework2021: Methodological foundation
|
|
68
|
+
- [...]
|
|
69
|
+
|
|
70
|
+
### Discussion
|
|
71
|
+
- critic2023: Contrasting view we address
|
|
72
|
+
- [...]
|
|
73
|
+
|
|
74
|
+
## Citation Notes
|
|
75
|
+
|
|
76
|
+
Key quotes or specific points to reference:
|
|
77
|
+
|
|
78
|
+
### smith2023
|
|
79
|
+
- p. 12: "[Exact quote that's useful]"
|
|
80
|
+
- p. 45: Data on adoption rates (Table 3)
|
|
81
|
+
|
|
82
|
+
### jones2024
|
|
83
|
+
- p. 7: "[Exact quote]"
|
|
84
|
+
- Key finding: 78% of researchers report ad hoc usage
|
|
85
|
+
|
|
86
|
+
---
|
|
87
|
+
|
|
88
|
+
*Literature index for: [Paper title]*
|
|
89
|
+
*Update as citations are added*
|
|
90
|
+
```
|
|
91
|
+
|
|
92
|
+
<guidelines>
|
|
93
|
+
|
|
94
|
+
**Status values:**
|
|
95
|
+
- `✓ cited` — Already in paper
|
|
96
|
+
- `pending` — Need to add
|
|
97
|
+
- `optional` — Use if space/relevance
|
|
98
|
+
|
|
99
|
+
**Core vs Supporting:**
|
|
100
|
+
- Core: Paper would be incomplete without these
|
|
101
|
+
- Supporting: Strengthen but not essential
|
|
102
|
+
- Background: Informed thinking, may not cite
|
|
103
|
+
|
|
104
|
+
**To Find section:**
|
|
105
|
+
- Captures citation gaps
|
|
106
|
+
- Be specific about what you need
|
|
107
|
+
- Link to the claim/section requiring it
|
|
108
|
+
|
|
109
|
+
**By Section view:**
|
|
110
|
+
- Quick reference during writing
|
|
111
|
+
- Shows citation distribution
|
|
112
|
+
- Helps avoid over/under-citing sections
|
|
113
|
+
|
|
114
|
+
**Citation Notes:**
|
|
115
|
+
- Capture key quotes with page numbers
|
|
116
|
+
- Note specific data or tables to reference
|
|
117
|
+
- Saves time during writing
|
|
118
|
+
|
|
119
|
+
**When to update:**
|
|
120
|
+
- After literature search
|
|
121
|
+
- When adding citations during writing
|
|
122
|
+
- After identifying gaps in argument
|
|
123
|
+
</guidelines>
|
|
124
|
+
|
|
125
|
+
<example>
|
|
126
|
+
```markdown
|
|
127
|
+
# Literature Index
|
|
128
|
+
|
|
129
|
+
**Created:** 2025-01-10
|
|
130
|
+
**Last updated:** 2025-01-20
|
|
131
|
+
**Total citations:** 8 core + 12 supporting
|
|
132
|
+
|
|
133
|
+
## Core References (Must Cite)
|
|
134
|
+
|
|
135
|
+
| Key | Citation | Relevance | Section | Status |
|
|
136
|
+
|-----|----------|-----------|---------|--------|
|
|
137
|
+
| smith2023 | Smith, J., Chen, L., & Davis, M. (2023). The proliferation of AI writing assistants: A systematic review. *Computers & Education*, 195, 104723. | Foundational survey | Intro | ✓ cited |
|
|
138
|
+
| jones2024 | Jones, A. (2024). How researchers use AI: A mixed-methods study. *Research Policy*, 53(2), 104891. | Usage patterns data | Intro, Results | ✓ cited |
|
|
139
|
+
| author2022 | Author, B. (2022). Academic writing in the digital age. *Written Communication*, 39(4), 567-592. | Academic constraints | Lit Review | pending |
|
|
140
|
+
| ethics2024 | Jones, A., & Chen, L. (2024). Ethics of AI co-authorship. *Science and Engineering Ethics*, 30(1), 1-18. | Ethics framework | Discussion | pending |
|
|
141
|
+
|
|
142
|
+
[...]
|
|
143
|
+
|
|
144
|
+
## To Find
|
|
145
|
+
|
|
146
|
+
- [ ] Power analysis citation for N=45 — for Methods sample size justification
|
|
147
|
+
- [ ] Comparable study with similar N — for Methods precedent
|
|
148
|
+
- [ ] Recent CHI paper on AI writing tools — for Lit Review currency
|
|
149
|
+
|
|
150
|
+
[...]
|
|
151
|
+
```
|
|
152
|
+
</example>
|
|
@@ -0,0 +1,122 @@
|
|
|
1
|
+
# Research Gaps Template
|
|
2
|
+
|
|
3
|
+
Template for `.planning/structure/gaps.md` — tracking research and evidence gaps.
|
|
4
|
+
|
|
5
|
+
**Purpose:** Identify and track gaps in your argument that need addressing before submission.
|
|
6
|
+
|
|
7
|
+
---
|
|
8
|
+
|
|
9
|
+
## File Template
|
|
10
|
+
|
|
11
|
+
```markdown
|
|
12
|
+
# Research & Evidence Gaps
|
|
13
|
+
|
|
14
|
+
**Created:** [date]
|
|
15
|
+
**Last updated:** [date]
|
|
16
|
+
**Status:** [X] open / [Y] resolved
|
|
17
|
+
|
|
18
|
+
## Critical Gaps (Must Address)
|
|
19
|
+
|
|
20
|
+
These gaps would cause rejection if not addressed.
|
|
21
|
+
|
|
22
|
+
### GAP-001: [Brief description]
|
|
23
|
+
|
|
24
|
+
**Type:** [Evidence / Citation / Logic / Data]
|
|
25
|
+
**Location:** [Section where gap appears]
|
|
26
|
+
**The gap:** [What's missing or weak]
|
|
27
|
+
**Impact:** [Why this matters for the argument]
|
|
28
|
+
**Status:** [Open / In progress / Resolved]
|
|
29
|
+
|
|
30
|
+
**Potential solutions:**
|
|
31
|
+
1. [Option 1]
|
|
32
|
+
2. [Option 2]
|
|
33
|
+
|
|
34
|
+
**Chosen approach:** [How we're addressing it]
|
|
35
|
+
**Resolution notes:** [What was done, if resolved]
|
|
36
|
+
|
|
37
|
+
### GAP-002: [Brief description]
|
|
38
|
+
|
|
39
|
+
[Same structure...]
|
|
40
|
+
|
|
41
|
+
## Major Gaps (Should Address)
|
|
42
|
+
|
|
43
|
+
These weaken the paper but may not cause rejection.
|
|
44
|
+
|
|
45
|
+
### GAP-003: [Brief description]
|
|
46
|
+
|
|
47
|
+
**Type:** [Evidence / Citation / Logic / Data]
|
|
48
|
+
**Location:** [Section]
|
|
49
|
+
**The gap:** [What's missing]
|
|
50
|
+
**Impact:** [How it weakens the argument]
|
|
51
|
+
**Status:** [Open / In progress / Resolved / Acknowledged as limitation]
|
|
52
|
+
|
|
53
|
+
**Potential solutions:**
|
|
54
|
+
1. [Option 1]
|
|
55
|
+
2. [Option 2]
|
|
56
|
+
|
|
57
|
+
**Chosen approach:** [How we're addressing it or acknowledging it]
|
|
58
|
+
|
|
59
|
+
## Minor Gaps (Nice to Address)
|
|
60
|
+
|
|
61
|
+
These are minor weaknesses reviewers might note.
|
|
62
|
+
|
|
63
|
+
### GAP-004: [Brief description]
|
|
64
|
+
|
|
65
|
+
**Type:** [Evidence / Citation / Logic / Data]
|
|
66
|
+
**Location:** [Section]
|
|
67
|
+
**The gap:** [What's missing]
|
|
68
|
+
**Status:** [Open / Deferred]
|
|
69
|
+
**Notes:** [Brief notes]
|
|
70
|
+
|
|
71
|
+
## Acknowledged Limitations
|
|
72
|
+
|
|
73
|
+
Gaps we're explicitly calling out rather than fixing.
|
|
74
|
+
|
|
75
|
+
| Gap | Acknowledgment Location | Rationale for Not Fixing |
|
|
76
|
+
|-----|------------------------|-------------------------|
|
|
77
|
+
| GAP-003 | Discussion, para 5 | Would require additional study |
|
|
78
|
+
| [ID] | [Location] | [Why not fixed] |
|
|
79
|
+
|
|
80
|
+
## Gap Summary
|
|
81
|
+
|
|
82
|
+
| Priority | Total | Open | Resolved | Acknowledged |
|
|
83
|
+
|----------|-------|------|----------|--------------|
|
|
84
|
+
| Critical | X | Y | Z | - |
|
|
85
|
+
| Major | X | Y | Z | A |
|
|
86
|
+
| Minor | X | Y | Z | A |
|
|
87
|
+
|
|
88
|
+
---
|
|
89
|
+
|
|
90
|
+
*Gap tracking for: [Paper title]*
|
|
91
|
+
*Review before submission*
|
|
92
|
+
```
|
|
93
|
+
|
|
94
|
+
<guidelines>
|
|
95
|
+
|
|
96
|
+
**Gap types:**
|
|
97
|
+
- Evidence: Need more data/examples
|
|
98
|
+
- Citation: Need supporting literature
|
|
99
|
+
- Logic: Argument leap without justification
|
|
100
|
+
- Data: Missing statistics or analysis
|
|
101
|
+
|
|
102
|
+
**Priority levels:**
|
|
103
|
+
- Critical: Reviewers will reject without this
|
|
104
|
+
- Major: Weakens paper significantly
|
|
105
|
+
- Minor: Would be nice to have
|
|
106
|
+
|
|
107
|
+
**Status values:**
|
|
108
|
+
- Open: Not yet addressed
|
|
109
|
+
- In progress: Working on it
|
|
110
|
+
- Resolved: Fixed
|
|
111
|
+
- Acknowledged: Noted as limitation
|
|
112
|
+
|
|
113
|
+
**When to update:**
|
|
114
|
+
- After writing each section
|
|
115
|
+
- After review/verification
|
|
116
|
+
- After getting feedback
|
|
117
|
+
|
|
118
|
+
**Integration:**
|
|
119
|
+
- Link to argument-map.md gaps section
|
|
120
|
+
- Reference in STATE.md
|
|
121
|
+
- Check during review-section
|
|
122
|
+
</guidelines>
|
|
@@ -0,0 +1,140 @@
|
|
|
1
|
+
# IMRaD Structure Reference
|
|
2
|
+
|
|
3
|
+
Reference document for IMRaD (Introduction, Methods, Results, and Discussion) paper structure.
|
|
4
|
+
|
|
5
|
+
**Purpose:** Quick reference for standard academic paper organization.
|
|
6
|
+
|
|
7
|
+
---
|
|
8
|
+
|
|
9
|
+
## IMRaD Overview
|
|
10
|
+
|
|
11
|
+
```
|
|
12
|
+
┌─────────────────────────────────────────┐
|
|
13
|
+
│ ABSTRACT (summary of all sections) │
|
|
14
|
+
├─────────────────────────────────────────┤
|
|
15
|
+
│ INTRODUCTION │
|
|
16
|
+
│ • What is the problem? │
|
|
17
|
+
│ • Why does it matter? │
|
|
18
|
+
│ • What is our contribution? │
|
|
19
|
+
├─────────────────────────────────────────┤
|
|
20
|
+
│ METHODS │
|
|
21
|
+
│ • How did we investigate? │
|
|
22
|
+
│ • What did we do? │
|
|
23
|
+
│ • How can it be reproduced? │
|
|
24
|
+
├─────────────────────────────────────────┤
|
|
25
|
+
│ RESULTS │
|
|
26
|
+
│ • What did we find? │
|
|
27
|
+
│ • What does the data show? │
|
|
28
|
+
├─────────────────────────────────────────┤
|
|
29
|
+
│ DISCUSSION │
|
|
30
|
+
│ • What does it mean? │
|
|
31
|
+
│ • How does it relate to prior work? │
|
|
32
|
+
│ • What are the limitations? │
|
|
33
|
+
│ • What comes next? │
|
|
34
|
+
├─────────────────────────────────────────┤
|
|
35
|
+
│ CONCLUSION (optional, may be in Disc.) │
|
|
36
|
+
│ • What should readers remember? │
|
|
37
|
+
└─────────────────────────────────────────┘
|
|
38
|
+
```
|
|
39
|
+
|
|
40
|
+
## Section Details
|
|
41
|
+
|
|
42
|
+
### Abstract
|
|
43
|
+
**Purpose:** Summarize the entire paper in one paragraph
|
|
44
|
+
**Length:** 150-300 words (venue-specific)
|
|
45
|
+
**Structure:**
|
|
46
|
+
- Background/Context (1-2 sentences)
|
|
47
|
+
- Gap/Problem (1 sentence)
|
|
48
|
+
- Approach/Methods (1-2 sentences)
|
|
49
|
+
- Key Results (2-3 sentences)
|
|
50
|
+
- Implications (1-2 sentences)
|
|
51
|
+
|
|
52
|
+
**Write:** Last, after all other sections complete
|
|
53
|
+
|
|
54
|
+
### Introduction
|
|
55
|
+
**Purpose:** Establish context, gap, and contribution
|
|
56
|
+
**Length:** ~10% of paper
|
|
57
|
+
**Structure:**
|
|
58
|
+
1. Hook: Open with compelling context
|
|
59
|
+
2. Background: What's known, what exists
|
|
60
|
+
3. Gap: What's missing or problematic
|
|
61
|
+
4. Contribution: What this paper provides
|
|
62
|
+
5. Roadmap: Preview of paper structure (optional)
|
|
63
|
+
|
|
64
|
+
**The "funnel":** Start broad, narrow to your specific contribution
|
|
65
|
+
|
|
66
|
+
### Methods
|
|
67
|
+
**Purpose:** Enable reproduction and establish validity
|
|
68
|
+
**Length:** 15-25% of paper (varies by field)
|
|
69
|
+
**Structure:**
|
|
70
|
+
- Participants/Sample/Materials
|
|
71
|
+
- Procedure/Protocol
|
|
72
|
+
- Measures/Instruments
|
|
73
|
+
- Analysis approach
|
|
74
|
+
- Ethical considerations (if applicable)
|
|
75
|
+
|
|
76
|
+
**Key principle:** Someone should be able to replicate from this section alone
|
|
77
|
+
|
|
78
|
+
### Results
|
|
79
|
+
**Purpose:** Present findings without interpretation
|
|
80
|
+
**Length:** 20-30% of paper
|
|
81
|
+
**Structure:**
|
|
82
|
+
- Organized by research question or hypothesis
|
|
83
|
+
- Present findings with supporting data
|
|
84
|
+
- Include statistics, figures, tables as needed
|
|
85
|
+
- Describe what you found, not what it means
|
|
86
|
+
|
|
87
|
+
**Key principle:** Facts only; interpretation comes in Discussion
|
|
88
|
+
|
|
89
|
+
### Discussion
|
|
90
|
+
**Purpose:** Interpret findings and situate in literature
|
|
91
|
+
**Length:** 20-25% of paper
|
|
92
|
+
**Structure:**
|
|
93
|
+
1. Summary: Brief recap of key findings
|
|
94
|
+
2. Interpretation: What the findings mean
|
|
95
|
+
3. Integration: How findings relate to prior work
|
|
96
|
+
4. Implications: What this means for theory/practice
|
|
97
|
+
5. Limitations: Honest assessment of weaknesses
|
|
98
|
+
6. Future work: Where to go from here
|
|
99
|
+
7. Conclusion: Final takeaway (if no separate section)
|
|
100
|
+
|
|
101
|
+
**Key principle:** Connect your dots; help readers understand significance
|
|
102
|
+
|
|
103
|
+
### Conclusion (if separate)
|
|
104
|
+
**Purpose:** Leave readers with key takeaway
|
|
105
|
+
**Length:** ~5% of paper
|
|
106
|
+
**Structure:**
|
|
107
|
+
- Restate main contribution
|
|
108
|
+
- Key implications
|
|
109
|
+
- Forward-looking statement
|
|
110
|
+
|
|
111
|
+
## Common Variations
|
|
112
|
+
|
|
113
|
+
### Literature Review Section
|
|
114
|
+
Some fields include a separate "Related Work" or "Background" section between Introduction and Methods.
|
|
115
|
+
|
|
116
|
+
### Combined Results and Discussion
|
|
117
|
+
Some venues allow or prefer combined "Results and Discussion" sections.
|
|
118
|
+
|
|
119
|
+
### Structured Abstracts
|
|
120
|
+
Some journals require structured abstracts with explicit headings (Background, Methods, Results, Conclusions).
|
|
121
|
+
|
|
122
|
+
### Grant-Specific Structures
|
|
123
|
+
Grants often use different structures (Specific Aims, Significance, Innovation, Approach).
|
|
124
|
+
|
|
125
|
+
## Word Budget Template
|
|
126
|
+
|
|
127
|
+
| Section | % of Paper | 8000-word paper | 5000-word paper |
|
|
128
|
+
|---------|------------|-----------------|-----------------|
|
|
129
|
+
| Abstract | - | 200-300 | 150-200 |
|
|
130
|
+
| Introduction | 10-15% | 800-1200 | 500-750 |
|
|
131
|
+
| Methods | 15-25% | 1200-2000 | 750-1250 |
|
|
132
|
+
| Results | 20-30% | 1600-2400 | 1000-1500 |
|
|
133
|
+
| Discussion | 20-25% | 1600-2000 | 1000-1250 |
|
|
134
|
+
| Conclusion | 5% | 400 | 250 |
|
|
135
|
+
| **Total** | - | **~8000** | **~5000** |
|
|
136
|
+
|
|
137
|
+
---
|
|
138
|
+
|
|
139
|
+
*IMRaD reference document*
|
|
140
|
+
*Adapt percentages to venue requirements*
|