wtf-p 0.1.0

package/write-the-f-paper/templates/data-inventory.md

@@ -0,0 +1,142 @@
+# Data Inventory Template
+
+Template for `.planning/sources/data.md` — evidence inventory for your paper.
+
+**Purpose:** Track all figures, tables, statistics, and data that will appear in the paper.
+
+---
+
+## File Template
+
+```markdown
+# Data & Evidence Inventory
+
+**Created:** [date]
+**Last updated:** [date]
+
+## Figures
+
+| ID | Description | Status | Section | File |
+|----|-------------|--------|---------|------|
+| Fig 1 | [Main result visualization] | [ready/draft/needed] | Results | `figures/fig-1-*.png` |
+| Fig 2 | [Method diagram] | [ready/draft/needed] | Methods | `figures/fig-2-*.png` |
+| Fig 3 | [Comparison chart] | [ready/draft/needed] | Results | `figures/fig-3-*.png` |
+
+### Figure Details
+
+**Figure 1: [Title]**
+- Purpose: [What this figure shows]
+- Data source: [Where the data comes from]
+- Status: [Ready / Needs polish / Not started]
+- Caption draft: "[Draft caption text]"
+- Alt text: "[Accessibility description]"
+
+**Figure 2: [Title]**
+- Purpose: [What this figure shows]
+- Data source: [Where the data comes from]
+- Status: [Ready / Needs polish / Not started]
+- Caption draft: "[Draft caption text]"
+- Alt text: "[Accessibility description]"
+
+## Tables
+
+| ID | Description | Status | Section | Format |
+|----|-------------|--------|---------|--------|
+| Table 1 | [Participant demographics] | [ready/draft/needed] | Methods | Inline |
+| Table 2 | [Main results] | [ready/draft/needed] | Results | Inline |
+| Table 3 | [Comparison with prior work] | [ready/draft/needed] | Discussion | Inline |
+
+### Table Details
+
+**Table 1: [Title]**
+- Purpose: [What this table shows]
+- Columns: [Column 1 | Column 2 | Column 3]
+- Data source: [Where the data comes from]
+- Status: [Ready / Needs polish / Not started]
+- Notes: [Any special formatting or notes]
+
+**Table 2: [Title]**
+- Purpose: [What this table shows]
+- Columns: [Column headers]
+- Data source: [Where the data comes from]
+- Status: [Ready / Needs polish / Not started]
+
+## Statistics
+
+| Finding | Test | Result | Section | Status |
+|---------|------|--------|---------|--------|
+| Group difference in X | t-test | t(43) = 2.34, p = .024, d = 0.45 | Results | ✓ verified |
+| Relationship between Y and Z | Pearson r | r = .67, p < .001 | Results | ✓ verified |
+| Model prediction | Regression | R² = .42, F(3, 41) = 9.87, p < .001 | Results | pending |
+
+### Statistical Notes
+- [Notes on statistical approach]
+- [Software used: R / SPSS / Python]
+- [Any assumptions checked]
+
+## Quotes & Excerpts
+
+| Source | Quote | Where to Use |
+|--------|-------|--------------|
+| Smith (2023), p. 12 | "[Exact quote]" | Introduction, gap statement |
+| Participant P7 | "[Quote from data]" | Results, qualitative section |
+| Jones (2024), p. 45 | "[Exact quote]" | Discussion, comparison |
+
+## Data Availability
+
+**Raw data:**
+- Location: [Path or repository]
+- Access: [Public / Upon request / Restricted]
+- Format: [CSV / Excel / etc.]
+
+**Processed data:**
+- Location: [Path]
+- Scripts: [Path to analysis scripts]
+
+**Supplementary materials:**
+- [What will be included in supplementary]
+
+## Missing Data
+
+Items we need but don't have yet:
+
+- [ ] [Missing item 1] - needed for [section]
+- [ ] [Missing item 2] - needed for [section]
+- [ ] [Missing item 3] - needed for [section]
+
+---
+
+*Data inventory for: [Paper title]*
+*Update as data is collected/processed*
+```
+
+<guidelines>
+
+**What to track:**
+- All figures with status and placement
+- All tables with structure and status
+- Key statistics with exact values
+- Important quotes from sources or data
+- Missing data items
+
+**Status values:**
+- Ready: Can be used as-is
+- Draft: Needs polish but content is there
+- Needed: Must be created
+- Pending: Waiting on something
+
+**Figure/Table naming:**
+- Use descriptive IDs (Fig 1, Table A1)
+- Include file paths for figures
+- Note format requirements
+
+**Statistics tracking:**
+- Include exact values for paper
+- Note verification status
+- Track software/methods used
+
+**Integration:**
+- Reference from section plans
+- Check during verification
+- Update as data is finalized
+</guidelines>

package/write-the-f-paper/templates/discovery.md

@@ -0,0 +1,146 @@
+# Discovery Template
+
+Template for `.planning/sections/XX-name/DISCOVERY.md` - shallow research for writing decisions.
+
+**Purpose:** Answer "which approach should we use" questions during mandatory discovery in plan-section.
+
+For deep literature research ("what does the field say about this"), use `/wtfp:research-section` which produces RESEARCH.md.
+
+---
+
+## File Template
+
+```markdown
+---
+section: XX-name
+type: discovery
+topic: [discovery-topic]
+---
+
+<session_initialization>
+Before beginning discovery, verify today's date:
+!`date +%Y-%m-%d`
+
+Use this date when searching for "current" or "latest" information.
+Example: If today is 2025-11-22, search for "2025" not "2024".
+</session_initialization>
+
+<discovery_objective>
+Discover [topic] to inform [section name] writing.
+
+Purpose: [What decision/approach this enables]
+Scope: [Boundaries]
+Output: DISCOVERY.md with recommendation
+</discovery_objective>
+
+<discovery_scope>
+<include>
+- [Question to answer]
+- [Approach to investigate]
+- [Specific comparison if needed]
+</include>
+
+<exclude>
+- [Out of scope for this discovery]
+- [Defer to writing phase]
+</exclude>
+</discovery_scope>
+
+<discovery_protocol>
+
+**Source Priority:**
+1. **Domain literature** - Peer-reviewed papers in the field
+2. **Authoritative sources** - Foundational texts, handbooks
+3. **WebSearch** - For recent developments, trends (verify all findings)
+
+**Quality Checklist:**
+Before completing discovery, verify:
+- [ ] All claims have authoritative sources (peer-reviewed or established)
+- [ ] Negative claims ("X is not possible") verified with citations
+- [ ] Methodological claims from primary sources (not secondary summaries)
+- [ ] WebSearch findings cross-checked with academic sources
+- [ ] Recent publications checked for field developments
+- [ ] Alternative approaches considered (not just first solution found)
+
+**Confidence Levels:**
+- HIGH: Peer-reviewed sources confirm
+- MEDIUM: Authoritative secondary sources confirm
+- LOW: WebSearch only or training knowledge only (mark for validation)
+
+</discovery_protocol>
+
+
+<output_structure>
+Create `.planning/sections/XX-name/DISCOVERY.md`:
+
+```markdown
+# [Topic] Discovery
+
+## Summary
+[2-3 paragraph executive summary - what was researched, what was found, what's recommended]
+
+## Primary Recommendation
+[What approach to take and why - be specific and actionable]
+
+## Alternatives Considered
+[What else was evaluated and why not chosen]
+
+## Key Findings
+
+### [Category 1]
+- [Finding with citation and relevance to our case]
+
+### [Category 2]
+- [Finding with citation and relevance]
+
+## Relevant Citations
+[Citations to add to literature.md]
+
+## Metadata
+
+<metadata>
+<confidence level="high|medium|low">
+[Why this confidence level - based on source quality and verification]
+</confidence>
+
+<sources>
+- [Primary authoritative sources used]
+</sources>
+
+<open_questions>
+[What couldn't be determined or needs validation during writing]
+</open_questions>
+
+<validation_checkpoints>
+[If confidence is LOW or MEDIUM, list specific things to verify during writing]
+</validation_checkpoints>
+</metadata>
+```
+</output_structure>
+
+<success_criteria>
+- All scope questions answered with authoritative sources
+- Quality checklist items completed
+- Clear primary recommendation
+- Low-confidence findings marked with validation checkpoints
+- Ready to inform PLAN.md creation
+</success_criteria>
+
+<guidelines>
+**When to use discovery:**
+- Methodological choice unclear (approach A vs B)
+- Need to understand field conventions
+- Framing decision required
+- Single question pending
+
+**When NOT to use:**
+- Established methods (standard statistical approaches)
+- Writing details (defer to execution)
+- Questions answerable from existing sources
+
+**When to use RESEARCH.md instead:**
+- Need comprehensive literature review
+- Complex theoretical background
+- "What does the field say about X" questions
+- Use `/wtfp:research-section` for these
+</guidelines>

package/write-the-f-paper/templates/issues.md

@@ -0,0 +1,59 @@
+# Project Issues Log
+
+Gaps, flaws, and enhancements discovered during writing. Not critical — address in revision.
+
+## Open Issues
+
+### ISS-001: [Brief description]
+
+- **Discovered:** Section [X] Task [Z] (YYYY-MM-DD)
+- **Type:** [Gap / Flaw / Citation / Structure / Clarity / Future Work]
+- **Description:** [What could be improved and why it would help]
+- **Impact:** Low (writing is correct, this would enhance)
+- **Effort:** [Quick / Medium / Substantial]
+- **Suggested section:** [Section number or "Revision"]
+
+## Closed Issues
+
+[Moved here when addressed]
+
+---
+
+## Template Notes
+
+**When to create:** First time an enhancement is deferred during writing.
+
+**Location:** `.planning/ISSUES.md`
+
+**ISS numbering:** Auto-increment from highest existing number.
+
+**Entry format:** Copy the ISS-001 block, update number and fields.
+
+**Closing issues:** Move entire block to "Closed Issues" section, add resolution note.
+
+## Issue Types
+
+| Type | Definition | Example |
+|------|------------|---------|
+| **Gap** | Missing evidence or argument | "Need citation for claim about X" |
+| **Flaw** | Logical issue or weak argument | "Conclusion doesn't follow from premises" |
+| **Citation** | Citation needed or incorrect | "Smith (2023) actually says opposite" |
+| **Structure** | Organization could improve | "Methods should come before results" |
+| **Clarity** | Prose is unclear or awkward | "Paragraph 3 is confusing" |
+| **Future Work** | Good idea but out of scope | "Could extend to domain Y" |
+
+## When to Log vs When to Fix
+
+**Log to ISSUES.md:**
+- Nice-to-haves discovered during writing
+- Improvements that would delay current section
+- Ideas for future revision
+- Minor clarity issues that don't block comprehension
+
+**Fix immediately (don't log):**
+- Factual errors
+- Logical contradictions
+- Missing required elements
+- Broken citations
+
+The distinction: If a reviewer would reject the paper for it, fix it now. If a reviewer might suggest it as an improvement, log it for later.

package/write-the-f-paper/templates/manuscript.md

@@ -0,0 +1,253 @@
+# Manuscript Template
+
+Template for `paper/[title].md` or `paper/[title].tex` — the actual paper output.
+
+**Purpose:** Structure for the manuscript file where writing lives.
+
+---
+
+## Markdown Template
+
+```markdown
+---
+title: "[Paper Title]"
+author:
+  - name: "[Author 1]"
+    affiliation: "[Institution]"
+    email: "[email]"
+  - name: "[Author 2]"
+    affiliation: "[Institution]"
+date: "[YYYY-MM-DD]"
+abstract: |
+  [Abstract text - 150-300 words]
+keywords:
+  - keyword1
+  - keyword2
+  - keyword3
+bibliography: references.bib
+csl: [path-to-csl-file.csl]
+---
+
+# Introduction
+
+[Introduction text...]
+
+# Related Work
+
+[Literature review text...]
+
+# Methods
+
+## Participants
+
+[Participants text...]
+
+## Procedure
+
+[Procedure text...]
+
+## Analysis
+
+[Analysis text...]
+
+# Results
+
+## Finding 1
+
+[Finding 1 text...]
+
+## Finding 2
+
+[Finding 2 text...]
+
+# Discussion
+
+## Summary of Findings
+
+[Summary text...]
+
+## Implications
+
+[Implications text...]
+
+## Limitations
+
+[Limitations text...]
+
+## Future Work
+
+[Future work text...]
+
+# Conclusion
+
+[Conclusion text...]
+
+# References
+
+<!-- References will be generated automatically from citations -->
+```
+
+## LaTeX Template
+
+```latex
+\documentclass[sigchi]{acmart}
+
+\usepackage{booktabs}
+
+\title{[Paper Title]}
+
+\author{[Author 1]}
+\affiliation{
+  \institution{[Institution]}
+  \city{[City]}
+  \country{[Country]}
+}
+\email{[email]}
+
+\author{[Author 2]}
+\affiliation{
+  \institution{[Institution]}
+}
+\email{[email]}
+
+\begin{abstract}
+[Abstract text - 150-300 words]
+\end{abstract}
+
+\keywords{keyword1, keyword2, keyword3}
+
+\begin{document}
+
+\maketitle
+
+\section{Introduction}
+
+[Introduction text...]
+
+\section{Related Work}
+
+[Literature review text...]
+
+\section{Methods}
+
+\subsection{Participants}
+
+[Participants text...]
+
+\subsection{Procedure}
+
+[Procedure text...]
+
+\subsection{Analysis}
+
+[Analysis text...]
+
+\section{Results}
+
+\subsection{Finding 1}
+
+[Finding 1 text...]
+
+\subsection{Finding 2}
+
+[Finding 2 text...]
+
+\section{Discussion}
+
+\subsection{Summary of Findings}
+
+[Summary text...]
+
+\subsection{Implications}
+
+[Implications text...]
+
+\subsection{Limitations}
+
+[Limitations text...]
+
+\subsection{Future Work}
+
+[Future work text...]
+
+\section{Conclusion}
+
+[Conclusion text...]
+
+\bibliographystyle{ACM-Reference-Format}
+\bibliography{references}
+
+\end{document}
+```
+
+<guidelines>
+
+**File organization:**
+
+```
+paper/
+├── manuscript.md          # Main document (Markdown)
+│   OR
+├── paper.tex             # Main document (LaTeX)
+├── references.bib        # Bibliography
+├── figures/              # Figure files
+│   ├── fig-1-*.png
+│   └── fig-2-*.png
+└── supplementary/        # Supplementary materials
+    └── appendix.md
+```
+
+**Section markers:**
+- Use clear headers for navigation
+- Keep heading levels consistent
+- Follow venue structure requirements
+
+**Citation integration:**
+- Markdown: Use `[@key]` or `@key`
+- LaTeX: Use `\cite{key}`
+- Keep bibliography updated
+
+**Figure/table placement:**
+- Reference in text before appearance
+- Use descriptive captions
+- Include alt text for accessibility
+
+**Writing workflow:**
+1. Write in sections (not all at once)
+2. Use PLAN.md for each section
+3. Commit after each section complete
+4. Update word count in STATE.md
+
+**Quality markers:**
+- [ ] All sections present
+- [ ] Word count within limits
+- [ ] All figures/tables referenced
+- [ ] All citations resolved
+- [ ] Formatting matches template
+</guidelines>
+
+<split_manuscript>
+For longer documents, split by section:
+
+```
+paper/
+├── manuscript.md          # Includes all sections
+│   OR
+├── sections/
+│   ├── 00-frontmatter.md  # Title, abstract, keywords
+│   ├── 01-introduction.md
+│   ├── 02-literature.md
+│   ├── 03-methods.md
+│   ├── 04-results.md
+│   ├── 05-discussion.md
+│   ├── 06-conclusion.md
+│   └── 99-references.md
+└── build.sh              # Combines into single file
+```
+
+Combine script:
+```bash
+#!/bin/bash
+cat sections/*.md > manuscript.md
+```
+</split_manuscript>