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.
Files changed (92) hide show
  1. package/LICENSE +21 -0
  2. package/README.md +338 -0
  3. package/bin/install.js +358 -0
  4. package/bin/uninstall.js +485 -0
  5. package/commands/wtfp/analyze-bib.md +326 -0
  6. package/commands/wtfp/check-refs.md +205 -0
  7. package/commands/wtfp/create-outline.md +275 -0
  8. package/commands/wtfp/discuss-section.md +71 -0
  9. package/commands/wtfp/export-latex.md +216 -0
  10. package/commands/wtfp/help.md +342 -0
  11. package/commands/wtfp/insert-section.md +130 -0
  12. package/commands/wtfp/list-assumptions.md +109 -0
  13. package/commands/wtfp/map-project.md +197 -0
  14. package/commands/wtfp/new-paper.md +443 -0
  15. package/commands/wtfp/pause-writing.md +145 -0
  16. package/commands/wtfp/plan-revision.md +180 -0
  17. package/commands/wtfp/plan-section.md +247 -0
  18. package/commands/wtfp/polish-prose.md +177 -0
  19. package/commands/wtfp/progress.md +325 -0
  20. package/commands/wtfp/remove-section.md +147 -0
  21. package/commands/wtfp/research-gap.md +235 -0
  22. package/commands/wtfp/resume-writing.md +142 -0
  23. package/commands/wtfp/review-section.md +409 -0
  24. package/commands/wtfp/submit-milestone.md +211 -0
  25. package/commands/wtfp/write-section.md +273 -0
  26. package/package.json +40 -0
  27. package/write-the-f-paper/references/checkpoints.md +213 -0
  28. package/write-the-f-paper/references/continuation-format.md +223 -0
  29. package/write-the-f-paper/references/git-integration.md +241 -0
  30. package/write-the-f-paper/references/imrad-structure.md +212 -0
  31. package/write-the-f-paper/references/length-estimation.md +148 -0
  32. package/write-the-f-paper/references/plan-format.md +361 -0
  33. package/write-the-f-paper/references/principles.md +158 -0
  34. package/write-the-f-paper/references/questioning.md +132 -0
  35. package/write-the-f-paper/references/research-pitfalls.md +208 -0
  36. package/write-the-f-paper/templates/config.json +30 -0
  37. package/write-the-f-paper/templates/context.md +179 -0
  38. package/write-the-f-paper/templates/continue-here.md +142 -0
  39. package/write-the-f-paper/templates/data-inventory.md +142 -0
  40. package/write-the-f-paper/templates/discovery.md +146 -0
  41. package/write-the-f-paper/templates/issues.md +59 -0
  42. package/write-the-f-paper/templates/manuscript.md +253 -0
  43. package/write-the-f-paper/templates/narrative-arc.md +227 -0
  44. package/write-the-f-paper/templates/outline.md +274 -0
  45. package/write-the-f-paper/templates/phase-prompt.md +348 -0
  46. package/write-the-f-paper/templates/prior-drafts.md +204 -0
  47. package/write-the-f-paper/templates/project-context/argument-structure.md +267 -0
  48. package/write-the-f-paper/templates/project-context/bibliography.md +152 -0
  49. package/write-the-f-paper/templates/project-context/gaps.md +122 -0
  50. package/write-the-f-paper/templates/project-context/imrad.md +140 -0
  51. package/write-the-f-paper/templates/project-context/peer-review.md +152 -0
  52. package/write-the-f-paper/templates/project-context/style-guide.md +198 -0
  53. package/write-the-f-paper/templates/project-context/tools.md +170 -0
  54. package/write-the-f-paper/templates/project.md +185 -0
  55. package/write-the-f-paper/templates/research.md +384 -0
  56. package/write-the-f-paper/templates/review-comments.md +253 -0
  57. package/write-the-f-paper/templates/revision-issues.md +169 -0
  58. package/write-the-f-paper/templates/roadmap.md +187 -0
  59. package/write-the-f-paper/templates/section-archive.md +178 -0
  60. package/write-the-f-paper/templates/section-context.md +114 -0
  61. package/write-the-f-paper/templates/section.md +128 -0
  62. package/write-the-f-paper/templates/state.md +244 -0
  63. package/write-the-f-paper/templates/summary.md +277 -0
  64. package/write-the-f-paper/venues/acm-cs.yaml +102 -0
  65. package/write-the-f-paper/venues/arxiv-ml.yaml +103 -0
  66. package/write-the-f-paper/venues/ieee-cs.yaml +100 -0
  67. package/write-the-f-paper/venues/nature.yaml +81 -0
  68. package/write-the-f-paper/venues/thesis-chapter.yaml +101 -0
  69. package/write-the-f-paper/workflows/create-outline.md +462 -0
  70. package/write-the-f-paper/workflows/create-outline.wcn.md +194 -0
  71. package/write-the-f-paper/workflows/discuss-section.md +249 -0
  72. package/write-the-f-paper/workflows/discuss-section.wcn.md +63 -0
  73. package/write-the-f-paper/workflows/execute-section.md +704 -0
  74. package/write-the-f-paper/workflows/execute-section.wcn.md +219 -0
  75. package/write-the-f-paper/workflows/list-assumptions.md +183 -0
  76. package/write-the-f-paper/workflows/list-assumptions.wcn.md +42 -0
  77. package/write-the-f-paper/workflows/lit-review-phase.md +281 -0
  78. package/write-the-f-paper/workflows/lit-review-phase.wcn.md +92 -0
  79. package/write-the-f-paper/workflows/map-project.md +359 -0
  80. package/write-the-f-paper/workflows/map-project.wcn.md +73 -0
  81. package/write-the-f-paper/workflows/plan-section.md +409 -0
  82. package/write-the-f-paper/workflows/plan-section.wcn.md +236 -0
  83. package/write-the-f-paper/workflows/research-gap.md +469 -0
  84. package/write-the-f-paper/workflows/research-gap.wcn.md +119 -0
  85. package/write-the-f-paper/workflows/resume-paper.md +274 -0
  86. package/write-the-f-paper/workflows/resume-paper.wcn.md +93 -0
  87. package/write-the-f-paper/workflows/review-section.md +329 -0
  88. package/write-the-f-paper/workflows/review-section.wcn.md +91 -0
  89. package/write-the-f-paper/workflows/submit-draft.md +368 -0
  90. package/write-the-f-paper/workflows/submit-draft.wcn.md +69 -0
  91. package/write-the-f-paper/workflows/transition.md +375 -0
  92. package/write-the-f-paper/workflows/transition.wcn.md +113 -0
@@ -0,0 +1,102 @@
1
+ # ACM Computer Science Conference/Journal Template
2
+ # Standard structure for ACM SIGMOD, SOSP, OSDI, EuroSys, etc.
3
+
4
+ name: ACM Computer Science
5
+ short: acm-cs
6
+ description: Standard ACM CS conference structure (systems, databases, architecture)
7
+
8
+ structure:
9
+ - number: 1
10
+ name: Introduction
11
+ slug: introduction
12
+ word_ratio: 0.15
13
+ purpose: |
14
+ Hook the reader with the problem. State contributions clearly.
15
+ End with paper organization paragraph.
16
+ subsections:
17
+ - Motivation and Problem Statement
18
+ - Contributions
19
+ - Paper Organization
20
+ citation_density: medium
21
+
22
+ - number: 2
23
+ name: Background and Motivation
24
+ slug: background
25
+ word_ratio: 0.12
26
+ purpose: |
27
+ Establish technical context. Define key concepts.
28
+ Motivate why existing solutions fall short.
29
+ subsections:
30
+ - Technical Background
31
+ - Motivating Example
32
+ - Problem Definition
33
+ citation_density: high
34
+
35
+ - number: 3
36
+ name: Approach and Methodology
37
+ slug: approach
38
+ word_ratio: 0.25
39
+ purpose: |
40
+ Core technical contribution. System design, algorithms, architecture.
41
+ This is the meat of the paper.
42
+ subsections:
43
+ - Overview
44
+ - Design/Architecture
45
+ - Key Techniques
46
+ - Implementation Details
47
+ citation_density: low
48
+
49
+ - number: 4
50
+ name: Evaluation and Experimental Results
51
+ slug: evaluation
52
+ word_ratio: 0.25
53
+ purpose: |
54
+ Prove it works. Benchmarks, comparisons, ablations.
55
+ Answer: Is it faster? More accurate? More scalable?
56
+ subsections:
57
+ - Experimental Setup
58
+ - Baseline Comparisons
59
+ - Performance Analysis
60
+ - Ablation Studies
61
+ citation_density: medium
62
+
63
+ - number: 5
64
+ name: Related Work
65
+ slug: related-work
66
+ word_ratio: 0.12
67
+ purpose: |
68
+ Position contribution in literature. Show you know the field.
69
+ Differentiate from similar work.
70
+ subsections:
71
+ - Category 1 (e.g., Systems approaches)
72
+ - Category 2 (e.g., ML-based approaches)
73
+ - Category 3 (e.g., Hybrid approaches)
74
+ citation_density: very_high
75
+
76
+ - number: 6
77
+ name: Conclusion and Future Work
78
+ slug: conclusion
79
+ word_ratio: 0.08
80
+ purpose: |
81
+ Summarize contributions. Acknowledge limitations.
82
+ Point to future directions.
83
+ subsections:
84
+ - Summary
85
+ - Limitations
86
+ - Future Directions
87
+ citation_density: none
88
+
89
+ optional_sections:
90
+ - name: Acknowledgments
91
+ position: after_conclusion
92
+ - name: Appendix
93
+ position: end
94
+
95
+ citation_style: acm
96
+ page_limit_hint: "12-14 pages (double column)"
97
+
98
+ notes: |
99
+ - Related Work typically comes AFTER evaluation in systems papers
100
+ - Contributions should be bulleted and specific
101
+ - Evaluation needs quantitative comparisons with baselines
102
+ - ACM venues expect reproducibility (artifact evaluation)
@@ -0,0 +1,103 @@
1
+ # arXiv ML/AI Conference Template
2
+ # Standard structure for NeurIPS, ICML, ICLR, AAAI, etc.
3
+
4
+ name: arXiv ML/AI
5
+ short: arxiv-ml
6
+ description: Standard ML conference structure (NeurIPS, ICML, ICLR style)
7
+
8
+ structure:
9
+ - number: 1
10
+ name: Introduction
11
+ slug: introduction
12
+ word_ratio: 0.12
13
+ purpose: |
14
+ Problem setup. Why this matters. Contribution summary.
15
+ ML papers are dense - get to the point fast.
16
+ subsections:
17
+ - Problem and Motivation
18
+ - Contributions
19
+ citation_density: medium
20
+
21
+ - number: 2
22
+ name: Related Work
23
+ slug: related-work
24
+ word_ratio: 0.10
25
+ purpose: |
26
+ Position in literature. ML moves fast - cite recent work.
27
+ Often brief, sometimes moved to appendix.
28
+ subsections:
29
+ - Prior Approaches
30
+ - Concurrent Work
31
+ citation_density: very_high
32
+
33
+ - number: 3
34
+ name: Preliminaries
35
+ slug: preliminaries
36
+ word_ratio: 0.08
37
+ purpose: |
38
+ Notation, problem formulation, background concepts.
39
+ Keep it tight - reviewers know the basics.
40
+ subsections:
41
+ - Notation
42
+ - Problem Setup
43
+ - Background
44
+ citation_density: medium
45
+
46
+ - number: 4
47
+ name: Method
48
+ slug: method
49
+ word_ratio: 0.25
50
+ purpose: |
51
+ Your algorithm/model. Math-heavy. Clear notation.
52
+ Pseudocode welcome. Theoretical analysis if applicable.
53
+ subsections:
54
+ - Overview
55
+ - Core Algorithm
56
+ - Theoretical Analysis
57
+ citation_density: low
58
+
59
+ - number: 5
60
+ name: Experiments
61
+ slug: experiments
62
+ word_ratio: 0.30
63
+ purpose: |
64
+ Empirical validation. Standard benchmarks required.
65
+ Ablations show each component matters.
66
+ subsections:
67
+ - Setup and Baselines
68
+ - Main Results
69
+ - Ablation Studies
70
+ - Analysis
71
+ citation_density: medium
72
+
73
+ - number: 6
74
+ name: Conclusion
75
+ slug: conclusion
76
+ word_ratio: 0.05
77
+ purpose: |
78
+ Brief wrap-up. Limitations often required section.
79
+ subsections:
80
+ - Summary
81
+ - Limitations
82
+ - Future Work
83
+ citation_density: none
84
+
85
+ optional_sections:
86
+ - name: Abstract
87
+ position: before_introduction
88
+ word_limit: 200
89
+ - name: Broader Impact
90
+ position: after_conclusion
91
+ - name: Appendix
92
+ position: end
93
+ notes: Proofs, additional experiments, hyperparameters
94
+
95
+ citation_style: neurips
96
+ page_limit_hint: "8-9 pages + references + appendix"
97
+
98
+ notes: |
99
+ - ML reviewers skim - make contributions crystal clear
100
+ - Notation consistency is critical
101
+ - Standard benchmarks expected (ImageNet, GLUE, etc.)
102
+ - Ablations are mandatory, not optional
103
+ - Broader Impact/Ethics statement increasingly required
@@ -0,0 +1,100 @@
1
+ # IEEE Computer Science Conference/Journal Template
2
+ # Standard structure for IEEE IPDPS, SC, HPDC, TPDS, etc.
3
+
4
+ name: IEEE Computer Science
5
+ short: ieee-cs
6
+ description: Standard IEEE CS conference structure (HPC, parallel systems, storage)
7
+
8
+ structure:
9
+ - number: 1
10
+ name: Introduction
11
+ slug: introduction
12
+ word_ratio: 0.15
13
+ purpose: |
14
+ Problem statement and motivation. Clear contribution list.
15
+ IEEE style: more formal, less narrative.
16
+ subsections:
17
+ - Problem Statement
18
+ - Motivation
19
+ - Contributions
20
+ - Organization
21
+ citation_density: medium
22
+
23
+ - number: 2
24
+ name: Background and Related Work
25
+ slug: background
26
+ word_ratio: 0.15
27
+ purpose: |
28
+ IEEE often combines background with related work upfront.
29
+ Technical foundations + literature positioning.
30
+ subsections:
31
+ - Technical Background
32
+ - Related Work
33
+ - Positioning
34
+ citation_density: very_high
35
+
36
+ - number: 3
37
+ name: System Design
38
+ slug: design
39
+ word_ratio: 0.22
40
+ purpose: |
41
+ Architecture and design decisions.
42
+ IEEE emphasizes clear diagrams and formal descriptions.
43
+ subsections:
44
+ - Architecture Overview
45
+ - Component Design
46
+ - Algorithms
47
+ - Optimizations
48
+ citation_density: low
49
+
50
+ - number: 4
51
+ name: Implementation
52
+ slug: implementation
53
+ word_ratio: 0.10
54
+ purpose: |
55
+ Implementation specifics. IEEE values reproducibility details.
56
+ Hardware/software environment, parameters.
57
+ subsections:
58
+ - System Implementation
59
+ - Experimental Platform
60
+ citation_density: low
61
+
62
+ - number: 5
63
+ name: Evaluation
64
+ slug: evaluation
65
+ word_ratio: 0.25
66
+ purpose: |
67
+ Rigorous experimental validation.
68
+ IEEE expects statistical rigor and scalability analysis.
69
+ subsections:
70
+ - Experimental Setup
71
+ - Performance Evaluation
72
+ - Scalability Analysis
73
+ - Comparative Analysis
74
+ citation_density: medium
75
+
76
+ - number: 6
77
+ name: Conclusion
78
+ slug: conclusion
79
+ word_ratio: 0.08
80
+ purpose: |
81
+ Brief summary. Future work optional but common.
82
+ subsections:
83
+ - Summary
84
+ - Future Work
85
+ citation_density: none
86
+
87
+ optional_sections:
88
+ - name: Acknowledgments
89
+ position: after_conclusion
90
+ - name: References
91
+ position: end
92
+
93
+ citation_style: ieee
94
+ page_limit_hint: "10-12 pages (double column)"
95
+
96
+ notes: |
97
+ - IEEE often wants Related Work early (Section 2)
98
+ - Implementation details get their own section
99
+ - Scalability analysis is expected for systems papers
100
+ - Figures should be IEEE-compliant (grayscale-friendly)
@@ -0,0 +1,81 @@
1
+ # Nature/Science IMRaD Template
2
+ # Standard structure for life sciences, interdisciplinary research
3
+
4
+ name: Nature/Science (IMRaD)
5
+ short: nature
6
+ description: Classic IMRaD structure for life sciences and Nature-family journals
7
+
8
+ structure:
9
+ - number: 1
10
+ name: Introduction
11
+ slug: introduction
12
+ word_ratio: 0.15
13
+ purpose: |
14
+ Funnel structure: broad context → specific gap → your contribution.
15
+ End with clear statement of what you did and found.
16
+ subsections:
17
+ - Context
18
+ - Gap
19
+ - Approach
20
+ citation_density: high
21
+
22
+ - number: 2
23
+ name: Methods
24
+ slug: methods
25
+ word_ratio: 0.25
26
+ purpose: |
27
+ Reproducibility is paramount. Every detail needed to replicate.
28
+ Often moved to end or supplementary in Nature-family.
29
+ subsections:
30
+ - Experimental Design
31
+ - Data Collection
32
+ - Analysis Methods
33
+ - Statistical Analysis
34
+ citation_density: medium
35
+
36
+ - number: 3
37
+ name: Results
38
+ slug: results
39
+ word_ratio: 0.30
40
+ purpose: |
41
+ Present findings objectively. No interpretation yet.
42
+ Each figure/table gets narrative explanation.
43
+ subsections:
44
+ - Finding 1
45
+ - Finding 2
46
+ - Finding 3
47
+ citation_density: low
48
+
49
+ - number: 4
50
+ name: Discussion
51
+ slug: discussion
52
+ word_ratio: 0.25
53
+ purpose: |
54
+ Interpret results. Connect to literature. Acknowledge limitations.
55
+ End with implications and future directions.
56
+ subsections:
57
+ - Interpretation
58
+ - Comparison to Literature
59
+ - Limitations
60
+ - Implications
61
+ citation_density: high
62
+
63
+ optional_sections:
64
+ - name: Abstract
65
+ position: before_introduction
66
+ word_limit: 150-250
67
+ - name: Acknowledgments
68
+ position: after_discussion
69
+ - name: Data Availability
70
+ position: end
71
+ - name: Supplementary Materials
72
+ position: end
73
+
74
+ citation_style: nature
75
+ page_limit_hint: "3000-5000 words main text"
76
+
77
+ notes: |
78
+ - Abstract is crucial - often only part read
79
+ - Methods may be brief in main text, detailed in supplement
80
+ - Results and Discussion sometimes combined
81
+ - Figures are premium real estate - make them count
@@ -0,0 +1,101 @@
1
+ # Thesis/Dissertation Chapter Template
2
+ # Flexible structure for PhD thesis chapters
3
+
4
+ name: Thesis Chapter
5
+ short: thesis
6
+ description: Flexible structure for dissertation chapters
7
+
8
+ structure:
9
+ - number: 1
10
+ name: Introduction
11
+ slug: introduction
12
+ word_ratio: 0.10
13
+ purpose: |
14
+ Chapter overview. How it fits in thesis narrative.
15
+ What reader will learn. Chapter roadmap.
16
+ subsections:
17
+ - Chapter Overview
18
+ - Motivation
19
+ - Chapter Organization
20
+ citation_density: medium
21
+
22
+ - number: 2
23
+ name: Background
24
+ slug: background
25
+ word_ratio: 0.15
26
+ purpose: |
27
+ Technical foundations for this chapter.
28
+ Can reference thesis background chapter for basics.
29
+ subsections:
30
+ - Relevant Concepts
31
+ - Problem Context
32
+ citation_density: high
33
+
34
+ - number: 3
35
+ name: Approach
36
+ slug: approach
37
+ word_ratio: 0.25
38
+ purpose: |
39
+ Your contribution. Design, methodology, implementation.
40
+ More space than conference paper - be thorough.
41
+ subsections:
42
+ - Design Overview
43
+ - Technical Details
44
+ - Implementation
45
+ citation_density: low
46
+
47
+ - number: 4
48
+ name: Evaluation
49
+ slug: evaluation
50
+ word_ratio: 0.25
51
+ purpose: |
52
+ Experimental validation. Can include negative results.
53
+ Thesis allows more exploration than conference paper.
54
+ subsections:
55
+ - Experimental Setup
56
+ - Results
57
+ - Analysis
58
+ - Discussion
59
+ citation_density: medium
60
+
61
+ - number: 5
62
+ name: Related Work
63
+ slug: related-work
64
+ word_ratio: 0.15
65
+ purpose: |
66
+ Comprehensive literature review for this chapter's topic.
67
+ More thorough than conference paper version.
68
+ subsections:
69
+ - Category 1
70
+ - Category 2
71
+ - Comparison and Positioning
72
+ citation_density: very_high
73
+
74
+ - number: 6
75
+ name: Summary
76
+ slug: summary
77
+ word_ratio: 0.08
78
+ purpose: |
79
+ Chapter contributions. Connection to thesis goals.
80
+ Transition to next chapter.
81
+ subsections:
82
+ - Chapter Contributions
83
+ - Limitations
84
+ - Transition to Next Chapter
85
+ citation_density: none
86
+
87
+ optional_sections:
88
+ - name: Chapter Abstract
89
+ position: before_introduction
90
+ - name: Appendix
91
+ position: end
92
+
93
+ citation_style: thesis
94
+ page_limit_hint: "30-50 pages per chapter"
95
+
96
+ notes: |
97
+ - Thesis chapters have more space - use it for clarity, not padding
98
+ - Can include more background than conference paper
99
+ - Negative results and failed approaches valuable
100
+ - Each chapter should standalone but connect to thesis narrative
101
+ - Committee expects comprehensive related work