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,348 @@
|
|
|
1
|
+
# Section Prompt Template
|
|
2
|
+
|
|
3
|
+
Template for `.planning/sections/XX-name/{section}-{plan}-PLAN.md` - executable section plans.
|
|
4
|
+
|
|
5
|
+
**Naming:** Use `{section}-{plan}-PLAN.md` format (e.g., `01-02-PLAN.md` for Section 1, Plan 2)
|
|
6
|
+
|
|
7
|
+
---
|
|
8
|
+
|
|
9
|
+
## File Template
|
|
10
|
+
|
|
11
|
+
```markdown
|
|
12
|
+
---
|
|
13
|
+
section: XX-name
|
|
14
|
+
type: write
|
|
15
|
+
writing-mode: [co-author | scaffold | reviewer]
|
|
16
|
+
---
|
|
17
|
+
|
|
18
|
+
<objective>
|
|
19
|
+
[What this section accomplishes for the reader - from roadmap section goal]
|
|
20
|
+
|
|
21
|
+
Purpose: [Why this section matters for the overall argument]
|
|
22
|
+
Output: [What artifacts will be created - draft text, citations, figures]
|
|
23
|
+
Word target: [Target word count for this plan]
|
|
24
|
+
</objective>
|
|
25
|
+
|
|
26
|
+
<execution_context>
|
|
27
|
+
~/.claude/write-the-f-paper/workflows/write-section.md
|
|
28
|
+
./summary.md
|
|
29
|
+
[If plan contains checkpoint tasks (type="checkpoint:*"), add:]
|
|
30
|
+
~/.claude/write-the-f-paper/references/checkpoints.md
|
|
31
|
+
</execution_context>
|
|
32
|
+
|
|
33
|
+
<context>
|
|
34
|
+
@.planning/PROJECT.md
|
|
35
|
+
@.planning/ROADMAP.md
|
|
36
|
+
@.planning/structure/argument-map.md
|
|
37
|
+
[If section context exists:]
|
|
38
|
+
@.planning/sections/XX-name/CONTEXT.md
|
|
39
|
+
[If prior sections relevant:]
|
|
40
|
+
@.planning/sections/YY-name/{section}-SUMMARY.md
|
|
41
|
+
[Relevant source files:]
|
|
42
|
+
@.planning/sources/literature.md
|
|
43
|
+
@paper/prior-section.md
|
|
44
|
+
</context>
|
|
45
|
+
|
|
46
|
+
<tasks>
|
|
47
|
+
|
|
48
|
+
<task type="auto">
|
|
49
|
+
<name>Task 1: [Action-oriented name]</name>
|
|
50
|
+
<output>paper/section-name.md (paragraphs X-Y)</output>
|
|
51
|
+
<action>[Specific writing action - what to write, what argument to make, what to avoid and WHY]</action>
|
|
52
|
+
<sources>[Citations to use, data to reference]</sources>
|
|
53
|
+
<verify>[How to verify quality - read aloud, check argument flow]</verify>
|
|
54
|
+
<done>[Measurable acceptance criteria - word count, claims made, citations included]</done>
|
|
55
|
+
</task>
|
|
56
|
+
|
|
57
|
+
<task type="auto">
|
|
58
|
+
<name>Task 2: [Action-oriented name]</name>
|
|
59
|
+
<output>paper/section-name.md (paragraphs X-Y)</output>
|
|
60
|
+
<action>[Specific writing action]</action>
|
|
61
|
+
<sources>[Citations to use]</sources>
|
|
62
|
+
<verify>[Quality check]</verify>
|
|
63
|
+
<done>[Acceptance criteria]</done>
|
|
64
|
+
</task>
|
|
65
|
+
|
|
66
|
+
<task type="checkpoint:decision" gate="blocking">
|
|
67
|
+
<decision>[What needs deciding - framing, emphasis, structure]</decision>
|
|
68
|
+
<context>[Why this decision matters for the argument]</context>
|
|
69
|
+
<options>
|
|
70
|
+
<option id="option-a">
|
|
71
|
+
<name>[Option name]</name>
|
|
72
|
+
<pros>[Benefits for the argument]</pros>
|
|
73
|
+
<cons>[Tradeoffs and limitations]</cons>
|
|
74
|
+
</option>
|
|
75
|
+
<option id="option-b">
|
|
76
|
+
<name>[Option name]</name>
|
|
77
|
+
<pros>[Benefits for the argument]</pros>
|
|
78
|
+
<cons>[Tradeoffs and limitations]</cons>
|
|
79
|
+
</option>
|
|
80
|
+
</options>
|
|
81
|
+
<resume-signal>[How to indicate choice - "Select: option-a or option-b"]</resume-signal>
|
|
82
|
+
</task>
|
|
83
|
+
|
|
84
|
+
<task type="auto">
|
|
85
|
+
<name>Task 3: [Action-oriented name]</name>
|
|
86
|
+
<output>paper/section-name.md, references.bib</output>
|
|
87
|
+
<action>[Specific writing action]</action>
|
|
88
|
+
<sources>[Citations to use]</sources>
|
|
89
|
+
<verify>[Quality check]</verify>
|
|
90
|
+
<done>[Acceptance criteria]</done>
|
|
91
|
+
</task>
|
|
92
|
+
|
|
93
|
+
<task type="checkpoint:human-verify" gate="blocking">
|
|
94
|
+
<what-written>[What Claude just wrote that needs verification]</what-written>
|
|
95
|
+
<how-to-verify>
|
|
96
|
+
1. Read: [Section to review]
|
|
97
|
+
2. Check: [Specific elements to verify]
|
|
98
|
+
3. Verify: [Accuracy of claims, citations]
|
|
99
|
+
4. Confirm: [Argument flows logically]
|
|
100
|
+
</how-to-verify>
|
|
101
|
+
<resume-signal>Type "approved" to continue, or describe issues to fix</resume-signal>
|
|
102
|
+
</task>
|
|
103
|
+
|
|
104
|
+
[Continue for all tasks - mix of auto and checkpoints as needed...]
|
|
105
|
+
|
|
106
|
+
</tasks>
|
|
107
|
+
|
|
108
|
+
<verification>
|
|
109
|
+
Before declaring section complete:
|
|
110
|
+
- [ ] Word count within target (+/- 10%)
|
|
111
|
+
- [ ] All claims have supporting evidence/citations
|
|
112
|
+
- [ ] Argument flows logically paragraph to paragraph
|
|
113
|
+
- [ ] No unsupported assertions
|
|
114
|
+
- [ ] [Section-specific criteria]
|
|
115
|
+
</verification>
|
|
116
|
+
|
|
117
|
+
<success_criteria>
|
|
118
|
+
|
|
119
|
+
- All tasks completed
|
|
120
|
+
- All verification checks pass
|
|
121
|
+
- Word count: [X-Y] words
|
|
122
|
+
- Citations: All claims supported
|
|
123
|
+
- [Section-specific criteria]
|
|
124
|
+
</success_criteria>
|
|
125
|
+
|
|
126
|
+
<output>
|
|
127
|
+
After completion, create `.planning/sections/XX-name/{section}-{plan}-SUMMARY.md`:
|
|
128
|
+
|
|
129
|
+
# Section [X] Plan [Y]: [Name] Summary
|
|
130
|
+
|
|
131
|
+
**[Substantive one-liner - what argument was made, not "section complete"]**
|
|
132
|
+
|
|
133
|
+
## Accomplishments
|
|
134
|
+
|
|
135
|
+
- [Key argument established]
|
|
136
|
+
- [Key argument established]
|
|
137
|
+
|
|
138
|
+
## Word Count
|
|
139
|
+
|
|
140
|
+
Target: [X] | Actual: [Y] | Delta: [+/-Z]
|
|
141
|
+
|
|
142
|
+
## Key Claims Made
|
|
143
|
+
|
|
144
|
+
- [Claim 1] - supported by [evidence]
|
|
145
|
+
- [Claim 2] - supported by [evidence]
|
|
146
|
+
|
|
147
|
+
## Citations Added
|
|
148
|
+
|
|
149
|
+
- Author (Year): [context]
|
|
150
|
+
- Author (Year): [context]
|
|
151
|
+
|
|
152
|
+
## Decisions Made
|
|
153
|
+
|
|
154
|
+
[Key decisions and rationale, or "None"]
|
|
155
|
+
|
|
156
|
+
## Issues Encountered
|
|
157
|
+
|
|
158
|
+
[Problems and resolutions, or "None"]
|
|
159
|
+
|
|
160
|
+
## Next Step
|
|
161
|
+
|
|
162
|
+
[If more plans in this section: "Ready for {section}-{next-plan}-PLAN.md"]
|
|
163
|
+
[If section complete: "Section complete, ready for next section"]
|
|
164
|
+
</output>
|
|
165
|
+
```
|
|
166
|
+
|
|
167
|
+
<key_elements>
|
|
168
|
+
From create-meta-prompts patterns:
|
|
169
|
+
|
|
170
|
+
- XML structure for Claude parsing
|
|
171
|
+
- @context references for file loading
|
|
172
|
+
- Task types: auto, checkpoint:human-action, checkpoint:human-verify, checkpoint:decision
|
|
173
|
+
- Action includes "what to avoid and WHY" (from intelligence-rules)
|
|
174
|
+
- Verification is specific to writing quality
|
|
175
|
+
- Success criteria includes word count and argument quality
|
|
176
|
+
- Output specification includes SUMMARY.md structure
|
|
177
|
+
</key_elements>
|
|
178
|
+
|
|
179
|
+
<scope_guidance>
|
|
180
|
+
**Plan sizing:**
|
|
181
|
+
|
|
182
|
+
- Aim for 2-3 tasks per plan
|
|
183
|
+
- If planning >3 tasks, split into multiple plans (01-01, 01-02, etc.)
|
|
184
|
+
- Target ~50% context usage maximum
|
|
185
|
+
- Complex sections: Create 01-01, 01-02, 01-03 plans instead of one large plan
|
|
186
|
+
|
|
187
|
+
**When to split:**
|
|
188
|
+
|
|
189
|
+
- Different argument threads (background vs contribution)
|
|
190
|
+
- Clear dependency boundaries (draft → revise → polish)
|
|
191
|
+
- Risk of context overflow (>50% estimated usage)
|
|
192
|
+
- Long sections that exceed word budget in single session
|
|
193
|
+
</scope_guidance>
|
|
194
|
+
|
|
195
|
+
<writing_modes>
|
|
196
|
+
**Writing mode affects task structure:**
|
|
197
|
+
|
|
198
|
+
**Co-author mode** (Claude drafts):
|
|
199
|
+
- Tasks produce full prose
|
|
200
|
+
- User reviews and refines
|
|
201
|
+
- Best for: Methods, background, boilerplate
|
|
202
|
+
|
|
203
|
+
**Scaffold mode** (Claude outlines):
|
|
204
|
+
- Tasks produce detailed outlines
|
|
205
|
+
- User writes prose from outline
|
|
206
|
+
- Best for: Results interpretation, discussion
|
|
207
|
+
|
|
208
|
+
**Reviewer mode** (Claude critiques):
|
|
209
|
+
- Tasks analyze existing draft
|
|
210
|
+
- Produces suggestions, not prose
|
|
211
|
+
- Best for: Polish, revision, argument strengthening
|
|
212
|
+
</writing_modes>
|
|
213
|
+
|
|
214
|
+
<good_examples>
|
|
215
|
+
|
|
216
|
+
```markdown
|
|
217
|
+
---
|
|
218
|
+
section: 01-introduction
|
|
219
|
+
type: write
|
|
220
|
+
writing-mode: co-author
|
|
221
|
+
---
|
|
222
|
+
|
|
223
|
+
<objective>
|
|
224
|
+
Write the introduction section establishing the research gap and our contribution.
|
|
225
|
+
|
|
226
|
+
Purpose: Hook readers, establish context, identify gap, state contribution, preview structure.
|
|
227
|
+
Output: paper/01-introduction.md, citations in references.bib
|
|
228
|
+
Word target: 800 words
|
|
229
|
+
</objective>
|
|
230
|
+
|
|
231
|
+
<execution_context>
|
|
232
|
+
~/.claude/write-the-f-paper/workflows/write-section.md
|
|
233
|
+
./summary.md
|
|
234
|
+
</execution_context>
|
|
235
|
+
|
|
236
|
+
<context>
|
|
237
|
+
@.planning/PROJECT.md
|
|
238
|
+
@.planning/ROADMAP.md
|
|
239
|
+
@.planning/structure/argument-map.md
|
|
240
|
+
@.planning/sections/01-introduction/CONTEXT.md
|
|
241
|
+
@.planning/sources/literature.md
|
|
242
|
+
</context>
|
|
243
|
+
|
|
244
|
+
<tasks>
|
|
245
|
+
|
|
246
|
+
<task type="auto">
|
|
247
|
+
<name>Task 1: Write opening hook and context</name>
|
|
248
|
+
<output>paper/01-introduction.md (paragraphs 1-2)</output>
|
|
249
|
+
<action>Open with a compelling hook that illustrates the problem we're solving. Follow with 1-2 paragraphs establishing the context: what exists in the field, what people have been doing, why it matters. Use narrative style, not list of citations. Avoid jargon-heavy opening - make it accessible.</action>
|
|
250
|
+
<sources>Smith (2023) for proliferation stats, Jones (2024) for usage patterns</sources>
|
|
251
|
+
<verify>Read aloud - does it hook attention? Does context flow naturally?</verify>
|
|
252
|
+
<done>~200 words, 2 paragraphs, 2-3 citations integrated naturally</done>
|
|
253
|
+
</task>
|
|
254
|
+
|
|
255
|
+
<task type="auto">
|
|
256
|
+
<name>Task 2: Identify the gap and state contribution</name>
|
|
257
|
+
<output>paper/01-introduction.md (paragraphs 3-4)</output>
|
|
258
|
+
<action>Transition from "what exists" to "what's missing." Clearly articulate the gap in current understanding/practice. Then state our contribution - what this paper provides. Use "However..." or "Yet..." for transition. Be specific about contribution - not "we explore X" but "we provide the first framework for Y."</action>
|
|
259
|
+
<sources>Brown (2023) for gap support, our prior work if applicable</sources>
|
|
260
|
+
<verify>Gap clearly stated? Contribution specific and falsifiable?</verify>
|
|
261
|
+
<done>~300 words, gap + contribution clear, positioned against literature</done>
|
|
262
|
+
</task>
|
|
263
|
+
|
|
264
|
+
<task type="auto">
|
|
265
|
+
<name>Task 3: Preview paper structure</name>
|
|
266
|
+
<output>paper/01-introduction.md (paragraph 5)</output>
|
|
267
|
+
<action>Brief roadmap of paper structure. "This paper proceeds as follows..." or similar. Keep concise - one sentence per section maximum. End on forward momentum.</action>
|
|
268
|
+
<sources>None needed</sources>
|
|
269
|
+
<verify>All major sections mentioned? Concise?</verify>
|
|
270
|
+
<done>~100 words, all sections previewed, reads smoothly</done>
|
|
271
|
+
</task>
|
|
272
|
+
|
|
273
|
+
</tasks>
|
|
274
|
+
|
|
275
|
+
<verification>
|
|
276
|
+
Before declaring section complete:
|
|
277
|
+
- [ ] Word count: 750-850 words
|
|
278
|
+
- [ ] Hook engages reader in first paragraph
|
|
279
|
+
- [ ] Gap clearly articulated
|
|
280
|
+
- [ ] Contribution is specific and testable
|
|
281
|
+
- [ ] All claims have citations
|
|
282
|
+
- [ ] Paper structure previewed
|
|
283
|
+
</verification>
|
|
284
|
+
|
|
285
|
+
<success_criteria>
|
|
286
|
+
|
|
287
|
+
- All tasks completed
|
|
288
|
+
- All verification checks pass
|
|
289
|
+
- Word count: 750-850 words
|
|
290
|
+
- Citations: 4-6 integrated naturally
|
|
291
|
+
- Introduction sets up rest of paper clearly
|
|
292
|
+
</success_criteria>
|
|
293
|
+
|
|
294
|
+
<output>
|
|
295
|
+
After completion, create `.planning/sections/01-introduction/01-01-SUMMARY.md`
|
|
296
|
+
</output>
|
|
297
|
+
```
|
|
298
|
+
|
|
299
|
+
</good_examples>
|
|
300
|
+
|
|
301
|
+
<bad_examples>
|
|
302
|
+
|
|
303
|
+
```markdown
|
|
304
|
+
# Section 1: Introduction
|
|
305
|
+
|
|
306
|
+
## Tasks
|
|
307
|
+
|
|
308
|
+
### Task 1: Write introduction
|
|
309
|
+
|
|
310
|
+
**Action**: Write the introduction
|
|
311
|
+
**Done when**: Introduction is written
|
|
312
|
+
```
|
|
313
|
+
|
|
314
|
+
This is useless. No XML structure, no @context, no verification, no specificity.
|
|
315
|
+
</bad_examples>
|
|
316
|
+
|
|
317
|
+
<guidelines>
|
|
318
|
+
**When to use:**
|
|
319
|
+
- Creating writing plans for each section
|
|
320
|
+
- One plan per 2-3 tasks, multiple plans per section if needed
|
|
321
|
+
- Always use XML structure for Claude parsing
|
|
322
|
+
|
|
323
|
+
**Task types:**
|
|
324
|
+
|
|
325
|
+
- `type="auto"`: Write without stopping
|
|
326
|
+
- `type="checkpoint:human-action"`: User must do something (gather data, check source)
|
|
327
|
+
- `type="checkpoint:human-verify"`: User must verify output (accuracy, argument quality)
|
|
328
|
+
- `type="checkpoint:decision"`: User must choose between approaches
|
|
329
|
+
|
|
330
|
+
**Gate values:**
|
|
331
|
+
|
|
332
|
+
- `gate="blocking"`: Must resolve before continuing
|
|
333
|
+
- `gate="optional"`: Can skip or defer
|
|
334
|
+
|
|
335
|
+
**Context references:**
|
|
336
|
+
|
|
337
|
+
- Use @path/to/file.md to load files
|
|
338
|
+
- Always include @.planning/PROJECT.md and @.planning/ROADMAP.md
|
|
339
|
+
- Include argument-map.md for coherence
|
|
340
|
+
- Include relevant source files (literature, prior sections)
|
|
341
|
+
- Include workflow/template references
|
|
342
|
+
|
|
343
|
+
**After completion:**
|
|
344
|
+
|
|
345
|
+
- Create SUMMARY.md in same directory
|
|
346
|
+
- Follow summary.md template structure
|
|
347
|
+
- Document word count, citations, decisions, issues
|
|
348
|
+
</guidelines>
|
|
@@ -0,0 +1,204 @@
|
|
|
1
|
+
# Prior Drafts Template
|
|
2
|
+
|
|
3
|
+
Template for `.planning/sources/prior-drafts.md` — index of existing material to incorporate.
|
|
4
|
+
|
|
5
|
+
**Purpose:** Track existing text, notes, and drafts that can inform or be incorporated into the paper.
|
|
6
|
+
|
|
7
|
+
---
|
|
8
|
+
|
|
9
|
+
## File Template
|
|
10
|
+
|
|
11
|
+
```markdown
|
|
12
|
+
# Prior Drafts & Existing Material
|
|
13
|
+
|
|
14
|
+
**Created:** [date]
|
|
15
|
+
**Last updated:** [date]
|
|
16
|
+
|
|
17
|
+
## Usable Material
|
|
18
|
+
|
|
19
|
+
Material that can be adapted or incorporated into the paper.
|
|
20
|
+
|
|
21
|
+
| Source | Type | Description | Target Section | Status |
|
|
22
|
+
|--------|------|-------------|----------------|--------|
|
|
23
|
+
| proposal.md | Prior draft | Original project proposal | Introduction | Review needed |
|
|
24
|
+
| methods-notes.md | Notes | Detailed procedure notes | Methods | Usable |
|
|
25
|
+
| pilot-results.docx | Draft | Preliminary results write-up | Results | Needs update |
|
|
26
|
+
| lit-review-v1.md | Prior draft | Literature review from coursework | Literature | Partial use |
|
|
27
|
+
|
|
28
|
+
### Source Details
|
|
29
|
+
|
|
30
|
+
**proposal.md**
|
|
31
|
+
- Location: `sources/proposal.md`
|
|
32
|
+
- Length: ~2000 words
|
|
33
|
+
- Quality: [Good / Needs revision / Reference only]
|
|
34
|
+
- Usable sections:
|
|
35
|
+
- Introduction framing (paragraphs 1-3): Can adapt
|
|
36
|
+
- Methods overview: Too brief, reference only
|
|
37
|
+
- Expected outcomes: Update with actual results
|
|
38
|
+
- Notes: [Any considerations for use]
|
|
39
|
+
|
|
40
|
+
**methods-notes.md**
|
|
41
|
+
- Location: `sources/methods-notes.md`
|
|
42
|
+
- Length: ~1500 words
|
|
43
|
+
- Quality: [Good / Needs revision / Reference only]
|
|
44
|
+
- Usable sections:
|
|
45
|
+
- Participant recruitment: Complete, use directly
|
|
46
|
+
- Procedure steps: Complete, use directly
|
|
47
|
+
- Analysis approach: Needs statistical detail
|
|
48
|
+
- Notes: [Any considerations]
|
|
49
|
+
|
|
50
|
+
**pilot-results.docx**
|
|
51
|
+
- Location: `sources/pilot-results.docx`
|
|
52
|
+
- Length: ~1000 words
|
|
53
|
+
- Quality: [Good / Needs revision / Reference only]
|
|
54
|
+
- Usable sections:
|
|
55
|
+
- Main findings: Update with full data
|
|
56
|
+
- Tables: Recreate with complete data
|
|
57
|
+
- Notes: [Any considerations]
|
|
58
|
+
|
|
59
|
+
## Key Passages to Incorporate
|
|
60
|
+
|
|
61
|
+
Specific text worth preserving or adapting.
|
|
62
|
+
|
|
63
|
+
### From proposal.md
|
|
64
|
+
|
|
65
|
+
**Gap statement (can adapt):**
|
|
66
|
+
> "[Exact text from prior document]"
|
|
67
|
+
|
|
68
|
+
Adapt for: Introduction, gap section
|
|
69
|
+
Notes: Update citations to current
|
|
70
|
+
|
|
71
|
+
**Core argument (reference):**
|
|
72
|
+
> "[Exact text]"
|
|
73
|
+
|
|
74
|
+
Adapt for: Throughout
|
|
75
|
+
Notes: Thesis unchanged, wording may need polish
|
|
76
|
+
|
|
77
|
+
### From methods-notes.md
|
|
78
|
+
|
|
79
|
+
**Procedure description (use directly):**
|
|
80
|
+
> "[Exact text]"
|
|
81
|
+
|
|
82
|
+
Adapt for: Methods, procedure section
|
|
83
|
+
Notes: Add timeline specifics
|
|
84
|
+
|
|
85
|
+
## Reference Material
|
|
86
|
+
|
|
87
|
+
Material to consult but not directly incorporate.
|
|
88
|
+
|
|
89
|
+
| Source | Description | Use For |
|
|
90
|
+
|--------|-------------|---------|
|
|
91
|
+
| advisor-feedback.pdf | Comments on proposal | Addressing known concerns |
|
|
92
|
+
| similar-paper.pdf | Paper with good structure | Style reference |
|
|
93
|
+
| field-notes.md | Data collection notes | Verifying details |
|
|
94
|
+
|
|
95
|
+
## Data Files
|
|
96
|
+
|
|
97
|
+
Raw data and analysis outputs.
|
|
98
|
+
|
|
99
|
+
| File | Description | Status |
|
|
100
|
+
|------|-------------|--------|
|
|
101
|
+
| survey-responses.csv | Main survey data | Analyzed |
|
|
102
|
+
| interview-transcripts/ | Interview data | Coded |
|
|
103
|
+
| analysis-output.R | Statistical results | Complete |
|
|
104
|
+
|
|
105
|
+
## Version History
|
|
106
|
+
|
|
107
|
+
Track major versions if relevant.
|
|
108
|
+
|
|
109
|
+
| Version | Date | Description |
|
|
110
|
+
|---------|------|-------------|
|
|
111
|
+
| Proposal v1 | 2024-06 | Initial project proposal |
|
|
112
|
+
| Pilot draft | 2024-10 | Pilot study write-up |
|
|
113
|
+
| This paper | 2025-01 | Full paper development |
|
|
114
|
+
|
|
115
|
+
---
|
|
116
|
+
|
|
117
|
+
*Prior drafts index for: [Paper title]*
|
|
118
|
+
*Update as material is used or added*
|
|
119
|
+
```
|
|
120
|
+
|
|
121
|
+
<guidelines>
|
|
122
|
+
|
|
123
|
+
**What to track:**
|
|
124
|
+
- Prior drafts of this or related work
|
|
125
|
+
- Notes and documentation
|
|
126
|
+
- Raw data and analysis files
|
|
127
|
+
- Relevant work from other projects
|
|
128
|
+
|
|
129
|
+
**Status values:**
|
|
130
|
+
- Usable: Can incorporate directly
|
|
131
|
+
- Review needed: Check before using
|
|
132
|
+
- Reference only: Consult but don't copy
|
|
133
|
+
- Outdated: Superseded by newer work
|
|
134
|
+
|
|
135
|
+
**For each source:**
|
|
136
|
+
- Location (file path)
|
|
137
|
+
- Length (rough word count)
|
|
138
|
+
- Quality assessment
|
|
139
|
+
- Which sections are usable
|
|
140
|
+
- How to adapt for current paper
|
|
141
|
+
|
|
142
|
+
**Key passages:**
|
|
143
|
+
- Exact quotes worth preserving
|
|
144
|
+
- Note target section
|
|
145
|
+
- Note any needed updates
|
|
146
|
+
|
|
147
|
+
**Integration:**
|
|
148
|
+
- Reference during section planning
|
|
149
|
+
- Check when writing sections
|
|
150
|
+
- Avoid accidental self-plagiarism (cite prior work if published)
|
|
151
|
+
</guidelines>
|
|
152
|
+
|
|
153
|
+
<example>
|
|
154
|
+
```markdown
|
|
155
|
+
# Prior Drafts & Existing Material
|
|
156
|
+
|
|
157
|
+
**Created:** 2025-01-10
|
|
158
|
+
**Last updated:** 2025-01-15
|
|
159
|
+
|
|
160
|
+
## Usable Material
|
|
161
|
+
|
|
162
|
+
| Source | Type | Description | Target Section | Status |
|
|
163
|
+
|--------|------|-------------|----------------|--------|
|
|
164
|
+
| chi-proposal.md | Prior draft | CHI submission proposal | Introduction | Usable |
|
|
165
|
+
| interview-analysis.md | Notes | Detailed interview analysis | Results | Usable |
|
|
166
|
+
| framework-v2.md | Draft | Framework documentation | Methods | Needs update |
|
|
167
|
+
|
|
168
|
+
### Source Details
|
|
169
|
+
|
|
170
|
+
**chi-proposal.md**
|
|
171
|
+
- Location: `sources/chi-proposal.md`
|
|
172
|
+
- Length: ~1500 words
|
|
173
|
+
- Quality: Good
|
|
174
|
+
- Usable sections:
|
|
175
|
+
- Opening hook (paragraph 1): Use directly with minor updates
|
|
176
|
+
- Problem statement (paragraphs 2-3): Adapt, add recent citations
|
|
177
|
+
- Contribution statement: Update with actual results
|
|
178
|
+
- Notes: Was well-received in proposal review; core framing is solid
|
|
179
|
+
|
|
180
|
+
**interview-analysis.md**
|
|
181
|
+
- Location: `sources/interview-analysis.md`
|
|
182
|
+
- Length: ~3000 words
|
|
183
|
+
- Quality: Good
|
|
184
|
+
- Usable sections:
|
|
185
|
+
- Theme 1 analysis: Use as Results subsection
|
|
186
|
+
- Theme 2 analysis: Use as Results subsection
|
|
187
|
+
- Key quotes: Select best for paper
|
|
188
|
+
- Notes: More detailed than paper needs; select highlights
|
|
189
|
+
|
|
190
|
+
## Key Passages to Incorporate
|
|
191
|
+
|
|
192
|
+
### From chi-proposal.md
|
|
193
|
+
|
|
194
|
+
**Opening hook (use directly):**
|
|
195
|
+
> "Dr. Chen stared at her half-finished methods section, torn between the unsettling AI-generated paragraph and the blank space that preceded it. Like many researchers, she had turned to AI writing tools hoping for help, only to find herself more confused about what help she actually needed."
|
|
196
|
+
|
|
197
|
+
Adapt for: Introduction, opening
|
|
198
|
+
Notes: Update to present tense if needed
|
|
199
|
+
|
|
200
|
+
---
|
|
201
|
+
|
|
202
|
+
*Prior drafts index for: AI-Assisted Writing Framework*
|
|
203
|
+
```
|
|
204
|
+
</example>
|