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,152 @@
|
|
|
1
|
+
# Peer Review Reference
|
|
2
|
+
|
|
3
|
+
Reference document for understanding and responding to peer review.
|
|
4
|
+
|
|
5
|
+
**Purpose:** Guide for interpreting reviewer comments and planning revisions.
|
|
6
|
+
|
|
7
|
+
---
|
|
8
|
+
|
|
9
|
+
## Understanding Reviewer Comments
|
|
10
|
+
|
|
11
|
+
### Comment Types
|
|
12
|
+
|
|
13
|
+
| Type | Definition | Response Strategy |
|
|
14
|
+
|------|------------|-------------------|
|
|
15
|
+
| **Required changes** | "Must revise X" | Fix exactly as requested |
|
|
16
|
+
| **Suggestions** | "Consider adding Y" | Address or explain why not |
|
|
17
|
+
| **Questions** | "Why did you choose Z?" | Answer clearly in revision |
|
|
18
|
+
| **Concerns** | "I worry about the validity of..." | Address substantively |
|
|
19
|
+
| **Minor notes** | "Typo on p. 5" | Fix immediately |
|
|
20
|
+
|
|
21
|
+
### Reading Between the Lines
|
|
22
|
+
|
|
23
|
+
**What they say → What they often mean:**
|
|
24
|
+
|
|
25
|
+
- "This is unclear" → Rewrite this section
|
|
26
|
+
- "More detail needed" → I couldn't follow your reasoning
|
|
27
|
+
- "Citation needed" → This claim seems unsupported
|
|
28
|
+
- "Consider X approach" → Why didn't you use X?
|
|
29
|
+
- "The contribution is incremental" → I don't see the significance
|
|
30
|
+
- "The sample size is small" → Acknowledge this limitation
|
|
31
|
+
|
|
32
|
+
### Severity Assessment
|
|
33
|
+
|
|
34
|
+
| Signal | Likely Meaning | Response Effort |
|
|
35
|
+
|--------|----------------|-----------------|
|
|
36
|
+
| "Minor revision" | Mostly good, small fixes | Days to a week |
|
|
37
|
+
| "Major revision" | Solid core, significant work needed | Weeks to months |
|
|
38
|
+
| "Reject with option to resubmit" | Fundamental issues, consider rethinking | Major rewrite |
|
|
39
|
+
| "Reject" | Wrong venue or fundamental flaws | New submission elsewhere |
|
|
40
|
+
|
|
41
|
+
## Response Letter Structure
|
|
42
|
+
|
|
43
|
+
```markdown
|
|
44
|
+
# Response to Reviewers
|
|
45
|
+
|
|
46
|
+
Dear Editor and Reviewers,
|
|
47
|
+
|
|
48
|
+
Thank you for the constructive feedback. We have carefully addressed all comments. Changes are highlighted in [blue/yellow] in the revised manuscript.
|
|
49
|
+
|
|
50
|
+
Below we respond to each comment in detail.
|
|
51
|
+
|
|
52
|
+
---
|
|
53
|
+
|
|
54
|
+
## Response to Reviewer 1
|
|
55
|
+
|
|
56
|
+
### Comment R1.1
|
|
57
|
+
> [Exact quote of reviewer comment]
|
|
58
|
+
|
|
59
|
+
**Response:** [How you addressed it]
|
|
60
|
+
|
|
61
|
+
**Changes made:** [Page X, paragraph Y: specific changes]
|
|
62
|
+
|
|
63
|
+
### Comment R1.2
|
|
64
|
+
> [Exact quote]
|
|
65
|
+
|
|
66
|
+
**Response:** [Your response]
|
|
67
|
+
|
|
68
|
+
**Changes made:** [Specific locations]
|
|
69
|
+
|
|
70
|
+
[Continue for all comments...]
|
|
71
|
+
|
|
72
|
+
---
|
|
73
|
+
|
|
74
|
+
## Response to Reviewer 2
|
|
75
|
+
|
|
76
|
+
[Same structure...]
|
|
77
|
+
|
|
78
|
+
---
|
|
79
|
+
|
|
80
|
+
## Summary of Major Changes
|
|
81
|
+
|
|
82
|
+
1. [Major change 1]
|
|
83
|
+
2. [Major change 2]
|
|
84
|
+
3. [Major change 3]
|
|
85
|
+
|
|
86
|
+
Thank you again for the opportunity to improve our work.
|
|
87
|
+
|
|
88
|
+
Sincerely,
|
|
89
|
+
[Authors]
|
|
90
|
+
```
|
|
91
|
+
|
|
92
|
+
## Common Issues and Solutions
|
|
93
|
+
|
|
94
|
+
### "The contribution is not clear"
|
|
95
|
+
- Rewrite Introduction gap and contribution sections
|
|
96
|
+
- Add explicit contribution statement
|
|
97
|
+
- Strengthen the "so what" in Discussion
|
|
98
|
+
|
|
99
|
+
### "Methods lack detail"
|
|
100
|
+
- Add procedural specifics
|
|
101
|
+
- Include participant demographics
|
|
102
|
+
- Specify statistical tests with justification
|
|
103
|
+
|
|
104
|
+
### "Sample size concerns"
|
|
105
|
+
- Add power analysis (if available)
|
|
106
|
+
- Cite precedent studies with similar N
|
|
107
|
+
- Acknowledge as limitation with effect size discussion
|
|
108
|
+
|
|
109
|
+
### "Missing related work"
|
|
110
|
+
- Add suggested citations
|
|
111
|
+
- Explain how your work relates
|
|
112
|
+
- Position contribution more clearly
|
|
113
|
+
|
|
114
|
+
### "Claims unsupported"
|
|
115
|
+
- Add citations for each claim
|
|
116
|
+
- Qualify overly strong claims
|
|
117
|
+
- Add "future work" for unverified claims
|
|
118
|
+
|
|
119
|
+
### "Statistical issues"
|
|
120
|
+
- Consult statistician if needed
|
|
121
|
+
- Justify test choices
|
|
122
|
+
- Report effect sizes, not just p-values
|
|
123
|
+
|
|
124
|
+
## Revision Workflow
|
|
125
|
+
|
|
126
|
+
1. **Import comments** → `/wtfp:import-reviews`
|
|
127
|
+
2. **Categorize by severity** → Critical / Major / Minor
|
|
128
|
+
3. **Create revision plan** → `/wtfp:plan-revision`
|
|
129
|
+
4. **Execute revisions** → `/wtfp:write-section`
|
|
130
|
+
5. **Write response letter** → `/wtfp:respond-reviews`
|
|
131
|
+
6. **Verify changes** → `/wtfp:review-section`
|
|
132
|
+
|
|
133
|
+
## Response Tone Guide
|
|
134
|
+
|
|
135
|
+
**Do:**
|
|
136
|
+
- Thank reviewers for helpful comments
|
|
137
|
+
- Be specific about changes made
|
|
138
|
+
- Explain reasoning when not making a change
|
|
139
|
+
- Quote the exact comment before responding
|
|
140
|
+
- Point to specific page/line numbers
|
|
141
|
+
|
|
142
|
+
**Don't:**
|
|
143
|
+
- Be defensive or dismissive
|
|
144
|
+
- Make excuses
|
|
145
|
+
- Ignore any comment
|
|
146
|
+
- Over-promise or under-deliver
|
|
147
|
+
- Argue with reviewer opinions
|
|
148
|
+
|
|
149
|
+
---
|
|
150
|
+
|
|
151
|
+
*Peer review reference document*
|
|
152
|
+
*Consult for revision planning*
|
|
@@ -0,0 +1,198 @@
|
|
|
1
|
+
# Style Guide Template
|
|
2
|
+
|
|
3
|
+
Template for `.planning/sources/style-guide.md` — writing conventions for this paper.
|
|
4
|
+
|
|
5
|
+
**Purpose:** Document the stylistic conventions to follow. Ensures consistency and meets venue requirements.
|
|
6
|
+
|
|
7
|
+
---
|
|
8
|
+
|
|
9
|
+
## File Template
|
|
10
|
+
|
|
11
|
+
```markdown
|
|
12
|
+
# Style Guide
|
|
13
|
+
|
|
14
|
+
**Venue:** [Journal/Conference name]
|
|
15
|
+
**Style:** [APA 7th / Chicago / IEEE / Custom]
|
|
16
|
+
**Created:** [date]
|
|
17
|
+
|
|
18
|
+
## Formatting Requirements
|
|
19
|
+
|
|
20
|
+
### Document Format
|
|
21
|
+
- **Page limit:** [X pages / Y words]
|
|
22
|
+
- **Font:** [Times New Roman 12pt / etc.]
|
|
23
|
+
- **Margins:** [1 inch / 2.5 cm]
|
|
24
|
+
- **Line spacing:** [Single / Double]
|
|
25
|
+
- **Template:** [Link to venue template if applicable]
|
|
26
|
+
|
|
27
|
+
### Section Requirements
|
|
28
|
+
- Abstract: [word limit, structure requirements]
|
|
29
|
+
- Keywords: [number required, format]
|
|
30
|
+
- Headings: [numbering system, capitalization]
|
|
31
|
+
- Figures/Tables: [placement, caption format]
|
|
32
|
+
- References: [style, format]
|
|
33
|
+
|
|
34
|
+
## Citation Style
|
|
35
|
+
|
|
36
|
+
### In-Text Citations
|
|
37
|
+
- Single author: (Smith, 2023)
|
|
38
|
+
- Two authors: (Smith & Jones, 2023)
|
|
39
|
+
- Three+ authors: (Smith et al., 2023)
|
|
40
|
+
- Multiple citations: (Smith, 2023; Jones, 2024)
|
|
41
|
+
- Direct quote: (Smith, 2023, p. 45)
|
|
42
|
+
|
|
43
|
+
### Reference List
|
|
44
|
+
- Format: [APA / Chicago / IEEE / other]
|
|
45
|
+
- DOI: [Required / Preferred / Optional]
|
|
46
|
+
- URL format: [Full URL / Shortened / None]
|
|
47
|
+
|
|
48
|
+
## Writing Conventions
|
|
49
|
+
|
|
50
|
+
### Voice and Tense
|
|
51
|
+
- **Voice:** [Active preferred / Passive acceptable]
|
|
52
|
+
- **Person:** [First person plural "we" / Third person]
|
|
53
|
+
- **Tense:**
|
|
54
|
+
- Introduction: [Present for established facts, past for prior work]
|
|
55
|
+
- Methods: [Past tense for what was done]
|
|
56
|
+
- Results: [Past tense for findings]
|
|
57
|
+
- Discussion: [Present for interpretation, past for summary]
|
|
58
|
+
|
|
59
|
+
### Terminology
|
|
60
|
+
- Use: [Preferred terms for key concepts]
|
|
61
|
+
- Avoid: [Terms to avoid or define]
|
|
62
|
+
- Acronyms: [Define on first use, then use acronym]
|
|
63
|
+
|
|
64
|
+
### Numbers and Statistics
|
|
65
|
+
- Numbers: [Spell out one-nine, numerals for 10+]
|
|
66
|
+
- Statistics: [Format: F(2, 45) = 3.21, p < .05]
|
|
67
|
+
- Percentages: [45% / 45 percent]
|
|
68
|
+
- Decimals: [Two decimal places for most statistics]
|
|
69
|
+
|
|
70
|
+
## Discipline-Specific Conventions
|
|
71
|
+
|
|
72
|
+
### [Field-specific section]
|
|
73
|
+
- [Convention 1]
|
|
74
|
+
- [Convention 2]
|
|
75
|
+
- [Convention 3]
|
|
76
|
+
|
|
77
|
+
## Common Errors to Avoid
|
|
78
|
+
|
|
79
|
+
- [ ] Anthropomorphizing AI ("the model thinks...")
|
|
80
|
+
- [ ] Hedging excessively ("it might possibly suggest...")
|
|
81
|
+
- [ ] Passive voice overuse
|
|
82
|
+
- [ ] Run-on sentences
|
|
83
|
+
- [ ] Inconsistent terminology
|
|
84
|
+
|
|
85
|
+
## Checklist Before Submission
|
|
86
|
+
|
|
87
|
+
- [ ] Word/page count within limits
|
|
88
|
+
- [ ] All sections present per venue requirements
|
|
89
|
+
- [ ] Abstract meets word limit and structure
|
|
90
|
+
- [ ] Keywords in required format
|
|
91
|
+
- [ ] All citations in reference list
|
|
92
|
+
- [ ] All references cited in text
|
|
93
|
+
- [ ] Figures/tables numbered and captioned
|
|
94
|
+
- [ ] Formatting matches template
|
|
95
|
+
- [ ] Author information anonymized (if required)
|
|
96
|
+
|
|
97
|
+
---
|
|
98
|
+
|
|
99
|
+
*Style guide for: [Paper title]*
|
|
100
|
+
*Venue: [Journal/Conference]*
|
|
101
|
+
```
|
|
102
|
+
|
|
103
|
+
<guidelines>
|
|
104
|
+
|
|
105
|
+
**When to create:**
|
|
106
|
+
- At project initialization
|
|
107
|
+
- After confirming target venue
|
|
108
|
+
- Before any significant writing
|
|
109
|
+
|
|
110
|
+
**Key sections:**
|
|
111
|
+
- Formatting: Page limits, fonts, margins
|
|
112
|
+
- Citations: How to cite, reference format
|
|
113
|
+
- Writing: Voice, tense, terminology
|
|
114
|
+
- Discipline: Field-specific conventions
|
|
115
|
+
|
|
116
|
+
**Sources for guidelines:**
|
|
117
|
+
- Venue author guidelines
|
|
118
|
+
- Style manual (APA, Chicago, etc.)
|
|
119
|
+
- Example papers from venue
|
|
120
|
+
- Editor/reviewer feedback on prior submissions
|
|
121
|
+
|
|
122
|
+
**Common venue variations:**
|
|
123
|
+
- Some require structured abstracts
|
|
124
|
+
- Some allow/disallow first person
|
|
125
|
+
- Page limits vs word limits
|
|
126
|
+
- Supplementary materials policies
|
|
127
|
+
</guidelines>
|
|
128
|
+
|
|
129
|
+
<example>
|
|
130
|
+
```markdown
|
|
131
|
+
# Style Guide
|
|
132
|
+
|
|
133
|
+
**Venue:** CHI 2025
|
|
134
|
+
**Style:** ACM / APA-like
|
|
135
|
+
**Created:** 2025-01-10
|
|
136
|
+
|
|
137
|
+
## Formatting Requirements
|
|
138
|
+
|
|
139
|
+
### Document Format
|
|
140
|
+
- **Page limit:** 10 pages (excluding references)
|
|
141
|
+
- **Font:** Use ACM template (default fonts)
|
|
142
|
+
- **Margins:** Per ACM template
|
|
143
|
+
- **Line spacing:** Per ACM template
|
|
144
|
+
- **Template:** [ACM CHI 2025 template](https://chi2025.acm.org/authors/)
|
|
145
|
+
|
|
146
|
+
### Section Requirements
|
|
147
|
+
- Abstract: 150 words max, single paragraph
|
|
148
|
+
- Keywords: 3-5 keywords, lowercase, semicolon-separated
|
|
149
|
+
- Headings: Numbered (1., 1.1, 1.1.1), sentence case
|
|
150
|
+
- Figures/Tables: Float to top/bottom, caption below figures, above tables
|
|
151
|
+
- References: ACM reference format
|
|
152
|
+
|
|
153
|
+
## Citation Style
|
|
154
|
+
|
|
155
|
+
### In-Text Citations
|
|
156
|
+
- Single author: Smith [23]
|
|
157
|
+
- Two authors: Smith and Jones [23]
|
|
158
|
+
- Three+ authors: Smith et al. [23]
|
|
159
|
+
- Multiple citations: [23, 45, 67]
|
|
160
|
+
- Direct quote: [23, p. 45]
|
|
161
|
+
|
|
162
|
+
### Reference List
|
|
163
|
+
- Format: ACM reference format
|
|
164
|
+
- DOI: Required when available
|
|
165
|
+
- URL format: Include access date
|
|
166
|
+
|
|
167
|
+
## Writing Conventions
|
|
168
|
+
|
|
169
|
+
### Voice and Tense
|
|
170
|
+
- **Voice:** Active preferred
|
|
171
|
+
- **Person:** First person plural "we"
|
|
172
|
+
- **Tense:**
|
|
173
|
+
- Introduction: Present for facts, past for prior work
|
|
174
|
+
- Methods: Past tense
|
|
175
|
+
- Results: Past tense
|
|
176
|
+
- Discussion: Present for interpretation
|
|
177
|
+
|
|
178
|
+
### Terminology
|
|
179
|
+
- Use: "participants" not "subjects"
|
|
180
|
+
- Use: "AI-assisted" not "AI-generated"
|
|
181
|
+
- Avoid: "users" when meaning "participants"
|
|
182
|
+
- Acronyms: Define on first use (e.g., "artificial intelligence (AI)")
|
|
183
|
+
|
|
184
|
+
## Checklist Before Submission
|
|
185
|
+
|
|
186
|
+
- [ ] 10 pages or fewer (excluding refs)
|
|
187
|
+
- [ ] Abstract ≤ 150 words
|
|
188
|
+
- [ ] 3-5 keywords
|
|
189
|
+
- [ ] All figures/tables referenced in text
|
|
190
|
+
- [ ] Accessibility: Alt text for figures
|
|
191
|
+
- [ ] Anonymized for review
|
|
192
|
+
|
|
193
|
+
---
|
|
194
|
+
|
|
195
|
+
*Style guide for: AI-Assisted Writing Framework*
|
|
196
|
+
*Venue: CHI 2025*
|
|
197
|
+
```
|
|
198
|
+
</example>
|
|
@@ -0,0 +1,170 @@
|
|
|
1
|
+
# Writing Tools Configuration
|
|
2
|
+
|
|
3
|
+
Template for `.planning/sources/tools.md` — configuration for writing tools and environments.
|
|
4
|
+
|
|
5
|
+
**Purpose:** Document the tools, formats, and technical setup for this writing project.
|
|
6
|
+
|
|
7
|
+
---
|
|
8
|
+
|
|
9
|
+
## File Template
|
|
10
|
+
|
|
11
|
+
```markdown
|
|
12
|
+
# Writing Tools
|
|
13
|
+
|
|
14
|
+
**Project:** [Paper/Grant title]
|
|
15
|
+
**Created:** [date]
|
|
16
|
+
|
|
17
|
+
## Output Format
|
|
18
|
+
|
|
19
|
+
**Primary format:** [LaTeX / Markdown / Word]
|
|
20
|
+
**Template:** [Venue template name/link]
|
|
21
|
+
**Citation manager:** [Zotero / Mendeley / BibTeX / None]
|
|
22
|
+
|
|
23
|
+
## File Locations
|
|
24
|
+
|
|
25
|
+
**Manuscript:**
|
|
26
|
+
- Main document: `paper/[filename].md` or `paper/[filename].tex`
|
|
27
|
+
- Sections (if split): `paper/sections/`
|
|
28
|
+
- References: `paper/references.bib`
|
|
29
|
+
|
|
30
|
+
**Figures:**
|
|
31
|
+
- Location: `paper/figures/`
|
|
32
|
+
- Format: [PNG / PDF / SVG]
|
|
33
|
+
- Naming: `fig-[N]-[description].[ext]`
|
|
34
|
+
|
|
35
|
+
**Tables:**
|
|
36
|
+
- Location: [Inline / `paper/tables/`]
|
|
37
|
+
- Format: [LaTeX / Markdown]
|
|
38
|
+
|
|
39
|
+
**Supplementary:**
|
|
40
|
+
- Location: `paper/supplementary/`
|
|
41
|
+
|
|
42
|
+
## Build/Compile
|
|
43
|
+
|
|
44
|
+
**For LaTeX:**
|
|
45
|
+
```bash
|
|
46
|
+
# Compile command
|
|
47
|
+
pdflatex paper.tex
|
|
48
|
+
bibtex paper
|
|
49
|
+
pdflatex paper.tex
|
|
50
|
+
pdflatex paper.tex
|
|
51
|
+
|
|
52
|
+
# Or with latexmk
|
|
53
|
+
latexmk -pdf paper.tex
|
|
54
|
+
```
|
|
55
|
+
|
|
56
|
+
**For Markdown:**
|
|
57
|
+
```bash
|
|
58
|
+
# Convert to PDF (via Pandoc)
|
|
59
|
+
pandoc paper.md -o paper.pdf --citeproc --bibliography=references.bib
|
|
60
|
+
|
|
61
|
+
# Convert to Word
|
|
62
|
+
pandoc paper.md -o paper.docx --citeproc --bibliography=references.bib
|
|
63
|
+
```
|
|
64
|
+
|
|
65
|
+
## Citation Format
|
|
66
|
+
|
|
67
|
+
**Style:** [APA 7 / Chicago / IEEE / ACM]
|
|
68
|
+
**CSL file:** [path to .csl if using Pandoc]
|
|
69
|
+
|
|
70
|
+
**In-text format:**
|
|
71
|
+
- Markdown: `[@smith2023]` or `@smith2023`
|
|
72
|
+
- LaTeX: `\cite{smith2023}` or `\citep{smith2023}`
|
|
73
|
+
|
|
74
|
+
**Reference format:**
|
|
75
|
+
```bibtex
|
|
76
|
+
@article{smith2023,
|
|
77
|
+
author = {Smith, John and Jones, Jane},
|
|
78
|
+
title = {Title of the Paper},
|
|
79
|
+
journal = {Journal Name},
|
|
80
|
+
year = {2023},
|
|
81
|
+
volume = {10},
|
|
82
|
+
number = {2},
|
|
83
|
+
pages = {100-120},
|
|
84
|
+
doi = {10.1234/example}
|
|
85
|
+
}
|
|
86
|
+
```
|
|
87
|
+
|
|
88
|
+
## Word Count
|
|
89
|
+
|
|
90
|
+
**Command for Markdown:**
|
|
91
|
+
```bash
|
|
92
|
+
# Excluding code blocks and front matter
|
|
93
|
+
pandoc paper.md -t plain | wc -w
|
|
94
|
+
```
|
|
95
|
+
|
|
96
|
+
**Command for LaTeX:**
|
|
97
|
+
```bash
|
|
98
|
+
# Using texcount
|
|
99
|
+
texcount paper.tex
|
|
100
|
+
|
|
101
|
+
# Or detex + wc
|
|
102
|
+
detex paper.tex | wc -w
|
|
103
|
+
```
|
|
104
|
+
|
|
105
|
+
## Verification Commands
|
|
106
|
+
|
|
107
|
+
**Check citations:**
|
|
108
|
+
```bash
|
|
109
|
+
# Find uncited references
|
|
110
|
+
grep -h "^@" references.bib | sed 's/@.*{//' | sed 's/,//' | while read key; do
|
|
111
|
+
grep -q "$key" paper.tex || echo "Uncited: $key"
|
|
112
|
+
done
|
|
113
|
+
|
|
114
|
+
# Find missing references
|
|
115
|
+
grep -oh '\\cite{[^}]*}' paper.tex | sed 's/\\cite{//; s/}//' | tr ',' '\n' | while read key; do
|
|
116
|
+
grep -q "^@.*{$key," references.bib || echo "Missing: $key"
|
|
117
|
+
done
|
|
118
|
+
```
|
|
119
|
+
|
|
120
|
+
**Grammar/style check:**
|
|
121
|
+
- [Tool: Grammarly / LanguageTool / Vale]
|
|
122
|
+
- [Configuration if applicable]
|
|
123
|
+
|
|
124
|
+
## Collaboration
|
|
125
|
+
|
|
126
|
+
**Version control:** [Git / None]
|
|
127
|
+
**Sharing:** [Overleaf / Google Docs / Email]
|
|
128
|
+
**Backup:** [Location/method]
|
|
129
|
+
|
|
130
|
+
## Special Requirements
|
|
131
|
+
|
|
132
|
+
[Any venue-specific technical requirements]
|
|
133
|
+
|
|
134
|
+
---
|
|
135
|
+
|
|
136
|
+
*Tools configuration for: [Paper title]*
|
|
137
|
+
*Update when tools change*
|
|
138
|
+
```
|
|
139
|
+
|
|
140
|
+
<guidelines>
|
|
141
|
+
|
|
142
|
+
**When to create:**
|
|
143
|
+
- At project initialization
|
|
144
|
+
- After selecting venue and format
|
|
145
|
+
|
|
146
|
+
**Key sections:**
|
|
147
|
+
- Output format and template
|
|
148
|
+
- File organization
|
|
149
|
+
- Build commands
|
|
150
|
+
- Citation format
|
|
151
|
+
- Word count methods
|
|
152
|
+
- Verification commands
|
|
153
|
+
|
|
154
|
+
**Format-specific notes:**
|
|
155
|
+
|
|
156
|
+
**LaTeX projects:**
|
|
157
|
+
- Include full compile sequence
|
|
158
|
+
- Note any required packages
|
|
159
|
+
- Document custom commands/macros
|
|
160
|
+
|
|
161
|
+
**Markdown projects:**
|
|
162
|
+
- Include Pandoc command with all options
|
|
163
|
+
- Note CSL file for citation style
|
|
164
|
+
- Document any extensions used
|
|
165
|
+
|
|
166
|
+
**Collaboration:**
|
|
167
|
+
- Note version control setup
|
|
168
|
+
- Document sharing method
|
|
169
|
+
- Include backup strategy
|
|
170
|
+
</guidelines>
|
|
@@ -0,0 +1,185 @@
|
|
|
1
|
+
# PROJECT.md Template
|
|
2
|
+
|
|
3
|
+
Template for `.planning/PROJECT.md` — the living writing project context document.
|
|
4
|
+
|
|
5
|
+
<template>
|
|
6
|
+
|
|
7
|
+
```markdown
|
|
8
|
+
# [Paper/Grant Title]
|
|
9
|
+
|
|
10
|
+
## What This Is
|
|
11
|
+
|
|
12
|
+
[Current accurate description — 2-3 sentences. What type of document is this (journal paper, conference paper, grant proposal)?
|
|
13
|
+
What is the target venue? What is the core contribution? Update whenever scope drifts from this description.]
|
|
14
|
+
|
|
15
|
+
## Core Argument
|
|
16
|
+
|
|
17
|
+
[The ONE thesis statement that matters most. If everything else is forgotten, this claim must come through.
|
|
18
|
+
One sentence that drives all writing decisions when tradeoffs arise.]
|
|
19
|
+
|
|
20
|
+
## Requirements
|
|
21
|
+
|
|
22
|
+
### Must Have
|
|
23
|
+
|
|
24
|
+
<!-- Required elements that cannot be omitted. -->
|
|
25
|
+
|
|
26
|
+
- [ ] [Required section or element]
|
|
27
|
+
- [ ] [Page/word limit compliance]
|
|
28
|
+
- [ ] [Specific formatting requirements]
|
|
29
|
+
- [ ] [Required figures, tables, or data]
|
|
30
|
+
|
|
31
|
+
### Should Have
|
|
32
|
+
|
|
33
|
+
<!-- Desired elements that strengthen the paper but aren't strictly required. -->
|
|
34
|
+
|
|
35
|
+
- [ ] [Desired element 1]
|
|
36
|
+
- [ ] [Desired element 2]
|
|
37
|
+
|
|
38
|
+
### Out of Scope
|
|
39
|
+
|
|
40
|
+
<!-- Explicit boundaries. Includes reasoning to prevent scope creep. -->
|
|
41
|
+
|
|
42
|
+
- [Not covering X] — [why]
|
|
43
|
+
- [Excluding Y approach] — [why]
|
|
44
|
+
|
|
45
|
+
## Target Audience
|
|
46
|
+
|
|
47
|
+
[Who reads this? What do they already know? What do they care about?
|
|
48
|
+
Consider primary reviewers, secondary readers, and citation audience.]
|
|
49
|
+
|
|
50
|
+
## Constraints
|
|
51
|
+
|
|
52
|
+
- **Deadline**: [Submission date]
|
|
53
|
+
- **Length**: [Word/page limit]
|
|
54
|
+
- **Format**: [LaTeX template, journal style, etc.]
|
|
55
|
+
- **Data**: [Available data, missing data, IRB constraints]
|
|
56
|
+
- **Prior work**: [Related papers, prior drafts, dependencies]
|
|
57
|
+
|
|
58
|
+
## Key Decisions
|
|
59
|
+
|
|
60
|
+
<!-- Decisions that constrain future writing. Add throughout project lifecycle. -->
|
|
61
|
+
|
|
62
|
+
| Decision | Rationale | Outcome |
|
|
63
|
+
|----------|-----------|---------|
|
|
64
|
+
| [Choice] | [Why] | [✓ Good / ⚠️ Revisit / — Pending] |
|
|
65
|
+
|
|
66
|
+
---
|
|
67
|
+
*Last updated: [date] after [trigger]*
|
|
68
|
+
```
|
|
69
|
+
|
|
70
|
+
</template>
|
|
71
|
+
|
|
72
|
+
<guidelines>
|
|
73
|
+
|
|
74
|
+
**What This Is:**
|
|
75
|
+
- Current accurate description of the paper or grant
|
|
76
|
+
- 2-3 sentences capturing document type, venue, and contribution
|
|
77
|
+
- Use the writer's framing and language
|
|
78
|
+
- Update when scope evolves beyond this description
|
|
79
|
+
|
|
80
|
+
**Core Argument:**
|
|
81
|
+
- The single thesis statement
|
|
82
|
+
- Everything else can be cut; this cannot
|
|
83
|
+
- Drives prioritization when word count is tight
|
|
84
|
+
- Rarely changes; if it does, it's a significant reframing
|
|
85
|
+
|
|
86
|
+
**Requirements — Must Have:**
|
|
87
|
+
- Non-negotiable elements
|
|
88
|
+
- Journal/conference requirements
|
|
89
|
+
- Figures or data that are essential
|
|
90
|
+
- Format: `- [ ] [Requirement]`
|
|
91
|
+
|
|
92
|
+
**Requirements — Should Have:**
|
|
93
|
+
- Elements that strengthen but aren't required
|
|
94
|
+
- Move to Must Have if they become essential
|
|
95
|
+
- Move to Out of Scope if they're cut
|
|
96
|
+
|
|
97
|
+
**Requirements — Out of Scope:**
|
|
98
|
+
- Explicit boundaries on what the paper is NOT about
|
|
99
|
+
- Always include reasoning (prevents scope creep)
|
|
100
|
+
- Includes: considered and rejected, deferred to future work, explicitly excluded
|
|
101
|
+
|
|
102
|
+
**Target Audience:**
|
|
103
|
+
- Who will review this? What's their expertise level?
|
|
104
|
+
- Who will cite this? What problem are they solving?
|
|
105
|
+
- What background can you assume vs. must explain?
|
|
106
|
+
|
|
107
|
+
**Constraints:**
|
|
108
|
+
- Hard limits on the writing
|
|
109
|
+
- Deadline, page limit, format requirements
|
|
110
|
+
- Data availability, IRB constraints, prior commitments
|
|
111
|
+
- Include the "why" — constraints without rationale get questioned
|
|
112
|
+
|
|
113
|
+
**Key Decisions:**
|
|
114
|
+
- Significant choices that affect future writing
|
|
115
|
+
- Add decisions as they're made throughout the project
|
|
116
|
+
- Track outcome when known:
|
|
117
|
+
- ✓ Good — decision proved correct
|
|
118
|
+
- ⚠️ Revisit — decision may need reconsideration
|
|
119
|
+
- — Pending — too early to evaluate
|
|
120
|
+
|
|
121
|
+
**Last Updated:**
|
|
122
|
+
- Always note when and why the document was updated
|
|
123
|
+
- Format: `after Section 2 draft` or `after reviewer feedback`
|
|
124
|
+
- Triggers review of whether content is still accurate
|
|
125
|
+
|
|
126
|
+
</guidelines>
|
|
127
|
+
|
|
128
|
+
<evolution>
|
|
129
|
+
|
|
130
|
+
PROJECT.md evolves throughout the writing lifecycle.
|
|
131
|
+
|
|
132
|
+
**After each section completion:**
|
|
133
|
+
1. Requirements invalidated? → Move to Out of Scope with reason
|
|
134
|
+
2. Requirements validated? → Move to Must Have with section reference
|
|
135
|
+
3. New requirements emerged? → Add to appropriate category
|
|
136
|
+
4. Decisions to log? → Add to Key Decisions
|
|
137
|
+
5. "What This Is" still accurate? → Update if drifted
|
|
138
|
+
|
|
139
|
+
**After each revision cycle:**
|
|
140
|
+
1. Full review of all sections
|
|
141
|
+
2. Core Argument check — still the right thesis?
|
|
142
|
+
3. Audit Out of Scope — reasons still valid?
|
|
143
|
+
4. Update constraints (new deadline, changed limits)
|
|
144
|
+
|
|
145
|
+
</evolution>
|
|
146
|
+
|
|
147
|
+
<brownfield>
|
|
148
|
+
|
|
149
|
+
For papers with existing drafts:
|
|
150
|
+
|
|
151
|
+
1. **Map sources first** via `/wtfp:map-project`
|
|
152
|
+
|
|
153
|
+
2. **Infer Must Have requirements** from existing writing:
|
|
154
|
+
- What sections already exist?
|
|
155
|
+
- What figures/data are available?
|
|
156
|
+
- What arguments are already made?
|
|
157
|
+
|
|
158
|
+
3. **Gather additional requirements** from user:
|
|
159
|
+
- Present inferred current state
|
|
160
|
+
- Ask what they want to accomplish
|
|
161
|
+
|
|
162
|
+
4. **Initialize:**
|
|
163
|
+
- Must Have = elements from existing drafts
|
|
164
|
+
- Should Have = user's goals for this revision
|
|
165
|
+
- Out of Scope = boundaries user specifies
|
|
166
|
+
- Constraints = includes prior draft state
|
|
167
|
+
|
|
168
|
+
</brownfield>
|
|
169
|
+
|
|
170
|
+
<state_reference>
|
|
171
|
+
|
|
172
|
+
STATE.md references PROJECT.md:
|
|
173
|
+
|
|
174
|
+
```markdown
|
|
175
|
+
## Project Reference
|
|
176
|
+
|
|
177
|
+
See: .planning/PROJECT.md (updated [date])
|
|
178
|
+
|
|
179
|
+
**Core argument:** [One-liner from Core Argument section]
|
|
180
|
+
**Current focus:** [Current section name]
|
|
181
|
+
```
|
|
182
|
+
|
|
183
|
+
This ensures Claude reads current PROJECT.md context.
|
|
184
|
+
|
|
185
|
+
</state_reference>
|