
Paper Writing
- 13 installs
- 2 repo stars
- Updated August 1, 2026
- vishalsachdev/claude-skills
This is a copy of paper-writing by vishalsachdev - installs and ranking accrue to the original listing.
Helps with ai & agent building tasks.
About
paper-writing is a Claude Code skill for ai & agent building. It helps solo builders move faster with AI-assisted development.
- paper-writing
- AI & Agent Building
- AI-coding skill
Paper Writing by the numbers
- 13 all-time installs (skills.sh)
- +1 installs in the week ending Jul 27, 2026 (Skillselion tracking)
- Data as of Aug 2, 2026 (Skillselion catalog sync)
npx skills add https://github.com/vishalsachdev/claude-skills --skill paper-writingAdd your badge
Show developers this skill is listed on Skillselion. Paste this into your README.
| Installs | 13 |
|---|---|
| repo stars | ★ 2 |
| Last updated | August 1, 2026 |
| Repository | vishalsachdev/claude-skills ↗ |
What it does
Helps with ai & agent building tasks.
Files
Academic Paper Writing Skill
This skill provides comprehensive guidance for writing excellent academic and research papers across all disciplines. It covers structure, style, argumentation, and best practices from initial planning through final revision.
When to Use This Skill
Use this skill when working on:
- Research papers and journal articles
- Conference papers and proceedings
- Technical reports and white papers
- Thesis chapters and dissertations
- Literature reviews and survey papers
- Position papers and perspectives
Quick Start
For immediate guidance, see the task-specific workflows below. For comprehensive reference material, consult:
references/REFERENCE.md- Complete writing guidelines and best practicesreferences/STRUCTURE.md- Detailed templates for different paper typesreferences/STYLE.md- Writing style and clarity guidelinesassets/- Ready-to-use paper templates
Core Workflow
1. Planning Phase
Understand the Requirements
- Identify target venue (journal, conference, report)
- Check formatting requirements (APA, IEEE, ACM, Chicago, etc.)
- Note page limits, section requirements, and citation style
- Clarify submission deadlines and review process
Define the Research Question
- Formulate a clear, focused research question or hypothesis
- Ensure the question is specific, measurable, and answerable
- Identify the gap in existing knowledge or practice
- State the contribution your work will make
Create an Outline
- Draft section headings based on paper type (see Structure section)
- Allocate approximate space to each section
- Identify key points for each section
- Map evidence and references to sections
2. Writing Phase
Follow the Structured Approach
Work section-by-section, not necessarily in order. Many authors write in this sequence: 1. Methods (clearest, most concrete) 2. Results (present findings) 3. Introduction (frame the problem) 4. Discussion (interpret results) 5. Conclusion (summarize contributions) 6. Abstract (last, summarizes everything)
Section-Specific Guidance
Abstract (150-300 words)
- State the problem and motivation (1-2 sentences)
- Describe your approach/method (1-2 sentences)
- Summarize key results (2-3 sentences)
- State conclusions and implications (1-2 sentences)
- Make it self-contained (no citations, no undefined acronyms)
Introduction
- Hook: Why should anyone care? (1 paragraph)
- Context: What's the broader problem space? (1-2 paragraphs)
- Gap: What's missing in current solutions? (1 paragraph)
- Your contribution: What does this paper do? (1 paragraph)
- Paper organization: Brief roadmap (optional, 1 paragraph)
Related Work / Literature Review
- Group work thematically, not chronologically
- Compare and contrast approaches
- Identify limitations of existing work
- Position your work clearly vs. alternatives
- Be fair and accurate (don't strawman competitors)
Methodology / Approach
- Describe methods with enough detail for replication
- Justify design choices
- Define metrics and evaluation criteria
- Explain data collection and analysis procedures
- Include diagrams for complex processes
Results
- Present findings objectively without interpretation
- Use tables and figures effectively (see Visualization section)
- Report statistical significance where applicable
- Address both positive and negative results
- Organize by research question or hypothesis
Discussion
- Interpret results in context of research questions
- Compare with related work
- Explain unexpected findings
- Acknowledge limitations honestly
- Discuss implications for theory and practice
Conclusion
- Restate key contributions (1 paragraph)
- Summarize main findings (1 paragraph)
- Discuss broader implications (1 paragraph)
- Suggest future work (1 paragraph)
- End with a strong closing statement
3. Refinement Phase
First Revision: Structure and Argument
- Does each section serve its purpose?
- Is the argument logical and complete?
- Are transitions between sections smooth?
- Does evidence support all claims?
- Are counterarguments addressed?
Second Revision: Clarity and Style
- Remove jargon and define technical terms
- Eliminate redundancy and wordiness
- Use active voice for clarity (prefer "We analyzed" over "Analysis was performed")
- Ensure parallel structure in lists
- Check paragraph length (aim for 4-8 sentences)
Third Revision: Polish
- Check grammar, spelling, punctuation
- Verify all citations are formatted correctly
- Ensure figures/tables are referenced in text
- Number sections, equations, figures consistently
- Proofread carefully (reading aloud helps)
Visualization Best Practices
Tables
- Use for precise numerical comparisons
- Keep simple and readable (avoid excessive gridlines)
- Include clear column headers and units
- Caption goes above the table
- Reference in text before the table appears
Figures
- Use for trends, patterns, relationships
- Ensure axes are labeled with units
- Use readable fonts (at least 10pt in final size)
- Caption goes below the figure
- Make interpretable in grayscale (avoid color-only distinctions)
General Rules
- Every table/figure must be referenced in the text
- Each should be self-explanatory with its caption
- Number consecutively (Figure 1, Figure 2, etc.)
- Place close to first reference when possible
Common Pitfalls to Avoid
Structural Issues
- ❌ Burying the contribution in the middle
- ✅ State contribution clearly in introduction
- ❌ Results section that interprets rather than presents
- ✅ Keep results objective, interpret in discussion
- ❌ Conclusion that introduces new information
- ✅ Conclusion only synthesizes existing content
Writing Issues
- ❌ Passive constructions: "It was found that..."
- ✅ Active voice: "We found that..."
- ❌ Hedging excessively: "It seems to possibly suggest..."
- ✅ Be direct: "The results indicate..."
- ❌ Undefined acronyms and jargon
- ✅ Define terms on first use
Citation Issues
- ❌ Missing citations for claims
- ✅ Every factual claim needs a source
- ❌ Over-citing obvious facts
- ✅ Common knowledge doesn't need citation
- ❌ Citing without reading (citation padding)
- ✅ Cite only what you've actually read and verified
Discipline-Specific Considerations
Computer Science / Engineering
- Emphasize reproducibility and implementation details
- Include complexity analysis where relevant
- Provide algorithm pseudocode or code snippets
- Compare against state-of-the-art baselines
- Make code/data available when possible
Natural Sciences
- Follow strict IMRAD structure (Intro, Methods, Results, Discussion)
- Report statistical power and effect sizes
- Include detailed experimental protocols
- Address confounding variables
- Report null results honestly
Social Sciences
- Contextualize within theoretical frameworks
- Justify sampling and participant selection
- Report demographic information
- Address potential biases
- Discuss generalizability limitations
Humanities
- Develop clear thesis statement
- Support arguments with textual evidence
- Engage with scholarly debates
- Use close reading and analysis
- Contextualize within historical/cultural frameworks
Conversation-First Approach
When helping users write papers, prioritize natural conversation over rapid-fire questions:
1. Start simple: Ask ONE opening question to understand their situation
- "What's your paper about?" (topic/working title)
- OR "What stage are you at?" (if they're already focused)
2. Listen and follow up: Based on their answer, ask the next most relevant question
- If they're starting: Ask about target venue or research gap
- If they're revising: Ask which section needs work
- If they're stuck: Ask what specific challenge they're facing
3. Build context progressively: Let information emerge naturally through dialogue
4. Provide targeted help: Focus on their immediate need, not all possible topics
5. Maintain author voice: Edit to improve, not to rewrite in a different style
6. Explain recommendations: Help them understand why changes strengthen their paper
7. Load references as needed: Use reference documents for deeper guidance only when relevant
Using Reference Materials
This skill includes detailed reference materials for deeper guidance:
- Load `references/REFERENCE.md` for comprehensive writing guidelines, style guides, and detailed best practices
- Load `references/STRUCTURE.md` for complete templates for different paper types (journal article, conference paper, thesis, etc.)
- Load `references/STYLE.md` for in-depth guidance on academic writing style, word choice, and clarity
- Check `assets/` for ready-to-use templates in various formats
Only load these materials when needed to conserve context. For most tasks, the guidance above is sufficient.
Progressive Enhancement
Basic use: Follow the Core Workflow for writing or revising papers
Intermediate use: Consult reference materials for specific sections or challenges
Advanced use: Use templates from assets/ and customize for specific venues
Quality Checklist
Before considering a paper complete, verify:
- [ ] Clear research question or contribution stated in introduction
- [ ] All claims supported by evidence or citations
- [ ] Logical flow from section to section
- [ ] Methods sufficiently detailed for replication
- [ ] Results presented objectively
- [ ] Discussion interprets results and addresses limitations
- [ ] All figures/tables referenced in text and have clear captions
- [ ] Citations formatted consistently
- [ ] Abstract accurately summarizes the paper
- [ ] No typos or grammatical errors
- [ ] Meets venue requirements (format, length, style)
Examples
Example 1: Progressive discovery—starting fresh
User: Help me write a research paper.
Claude: What's your paper about? (topic, working title, or research question)
User: It's about federated learning for edge devices.
Claude: Got it—that's a focused topic. Are you at the stage of having completed
research and needing to write it up, or are you still planning the work?
User: I've done the research and have preliminary results. I just don't know
where to start.
Claude: Perfect—let me help you structure this. What's your target venue?
(e.g., a specific conference, journal, or is this a thesis chapter?)Notice: One question asked, then the next, building naturally from their answers.
---
Example 2: Targeted revision (existing draft)
User: My introduction feels weak and I'm not sure why.
Claude: I'd like to take a look. Can you share what you have, or tell me
what the main challenge is? (e.g., doesn't grab attention, doesn't explain
why this work matters, etc.)
User: I think I'm not making the research gap clear enough. Here's what I wrote...
Claude: [Reads their draft]
Looking at your introduction, I see you've identified the problem nicely,
but you're right—the gap (what's missing in current solutions) isn't
explicit. Here's what I'd suggest...Notice: Start with curiosity about their specific challenge, then provide targeted feedback on the actual content.
---
Example 3: Stuck in the middle
User: I have my methods section written, but I'm stuck on results.
Claude: What's tripping you up about the results section specifically?
(e.g., how to organize findings, whether to include raw data, interpretation
vs. presentation, etc.)
User: I have a lot of data. I don't know what to include and how to present it
so it's not overwhelming.
Claude: That's a common challenge. Let me help you think through data selection
and visualization...Notice: Rather than lecturing about results sections in general, we drill down into their specific problem first.
## Tips for Success
**Writing Process**
- Write regularly in focused sessions (2-3 hours)
- Don't edit while drafting (separate creation from refinement)
- Get feedback early and often
- Read papers in your target venue for style/structure
**Revision Strategy**
- Take breaks between revision passes
- Read paper aloud to catch awkward phrasing
- Get fresh eyes (colleagues, advisors)
- Use revision checklist systematically
**Time Management**
- Allocate 40% planning, 30% writing, 30% revision
- Build in buffer time before deadlines
- Start with rough drafts, refine iteratively
- Don't aim for perfection in first draft
Remember: All good papers go through multiple revisions. Writing is rewriting.
Bud1 tsbwspblobassetsbwspblob�bplist00�]ShowStatusBar[ShowToolbar[ShowTabView_ContainerShowSidebar\WindowBounds[ShowSidebar _{{437, 549}, {920, 436}} #/;R_klmno�
�assetsvSrnlong
referencesbwspblob�bplist00�]ShowStatusBar[ShowToolbar[ShowTabView_ContainerShowSidebar\WindowBounds[ShowSidebar _{{437, 549}, {920, 436}} #/;R_klmno�
�
referencesvSrnlong @� @� @� @E DSDB `� @� @� @[Title: Make It Clear and Specific]
Authors: Author Name¹, Author Name², Author Name¹ Affiliations: ¹Institution 1, ²Institution 2 Contact: corresponding.author@email.com
---
Abstract
<!-- 150-300 words, self-contained summary --> [Background (1-2 sentences):] [Why this problem matters]
[Problem (1 sentence):] [Specific problem addressed]
[Solution (1-2 sentences):] [Your key insight and approach]
[Results (2-3 sentences):] [Main findings with specific numbers]
[Impact (1 sentence):] [Significance and implications]
---
1. Introduction
<!-- Get to your contribution quickly (1-1.5 pages) -->
[Hook paragraph:] [Why should anyone care about this problem?]
[Context paragraphs:] [What's the broader landscape? What have others done?]
[Gap paragraph:] [What's missing? Why existing solutions fall short?]
[Key insight:] [What's your core idea that makes this work?]
[Contributions paragraph:] This paper makes the following contributions:
• [Contribution 1]: [Novel technique/algorithm/framework] that [what it achieves] by [key mechanism]
• [Contribution 2]: [Theoretical analysis/proof] showing [property] with [bound/complexity] (Section X, Theorem Y)
• [Contribution 3]: [Empirical evaluation] demonstrating [performance gain] on [benchmarks] compared to [baselines] (Section X)
• [Contribution 4]: [Open-source release] of [code/data/model] at [URL] for reproducibility
---
2. Background and Problem Formulation
<!-- Define the problem formally (0.5-1 page) -->
2.1 Problem Definition
[Formal problem statement]
Given: [Input description]
Goal: [Objective, possibly with formal notation]
Constraints: [Any constraints or requirements]
2.2 Notation and Preliminaries
Table 1: Notation
| Symbol | Meaning |
|---|---|
| $n$ | [Description] |
| $G = (V, E)$ | [Description] |
| $\mathcal{D}$ | [Description] |
[Any background concepts needed to understand your approach]
---
3. Approach
<!-- Core technical content (2-3 pages) -->
3.1 Overview
[High-level intuition in plain language]
Figure 1: System architecture / Overview diagram
[Diagram showing overall approach]3.2 [Component/Algorithm 1]
[Detailed description of first major component]
Algorithm 1: [Algorithm Name]
Input: [inputs]
Output: [outputs]
1: procedure NAME(parameters)
2: initialize [variables]
3: while [condition] do
4: [step 1]
5: [step 2]
6: end while
7: return [result][Explanation of algorithm logic and why it works]
3.3 [Component/Algorithm 2]
[Detailed description of second major component]
3.4 [Integration/Full System]
[How components work together]
3.5 Theoretical Analysis (if applicable)
Theorem 1 (Complexity): [Statement]
Proof sketch: [Key ideas of the proof, or defer to appendix]
Theorem 2 (Correctness): [Statement]
Proof: [Proof or reference to appendix]
---
4. Experimental Evaluation
<!-- Demonstrate that it works (2-3 pages) -->
4.1 Experimental Setup
Datasets: We evaluate on [N] benchmark datasets:
- Dataset A [citation]: [Size, characteristics, why it's relevant]
- Dataset B [citation]: [Size, characteristics, why it's relevant]
- Dataset C [citation]: [Size, characteristics, why it's relevant]
Baselines: We compare against [N] state-of-the-art methods:
- Method 1 [citation]: [Brief description, year]
- Method 2 [citation]: [Brief description, year]
- Method 3 [citation]: [Brief description, year]
Metrics:
- [Metric 1]: [Why appropriate for this problem]
- [Metric 2]: [Why appropriate for this problem]
- [Metric 3]: [Runtime / scalability]
Implementation Details:
- Platform: [Python 3.10, PyTorch 2.0, etc.]
- Hardware: [GPU model, CPU specs]
- Hyperparameters: [Learning rate α = X, batch size = Y, etc.]
- Code: Available at [URL]
4.2 Main Results
Table 2: Performance comparison on [Dataset/Task]
| Method | Metric 1 ↑ | Metric 2 ↑ | Runtime ↓ | Year |
|---|---|---|---|---|
| Baseline 1 | XX.X% | XX.X% | XXs | 2023 |
| Baseline 2 | XX.X% | XX.X% | XXs | 2024 |
| Ours | XX.X% | XX.X% | XXs | 2025 |
[Analysis of results] Our method achieves [performance] on [dataset], outperforming the best baseline ([method]) by [X%]. Notably, we achieve this while being [Y×] faster.
Figure 2: [Performance visualization - accuracy vs. time, scaling curves, etc.]
[Graph or chart showing key results]4.3 Ablation Studies
[Systematically remove components to show what contributes]
Table 3: Ablation study on [Dataset]
| Configuration | Metric 1 | Metric 2 | Δ from Full |
|---|---|---|---|
| Full model | XX.X% | XX.X% | - |
| w/o [Component A] | XX.X% | XX.X% | -X.X% |
| w/o [Component B] | XX.X% | XX.X% | -X.X% |
| w/o [Both] | XX.X% | XX.X% | -X.X% |
[Interpretation] These results show that [component A] contributes [X%] to overall performance, while [component B] contributes [Y%]. Both components are necessary for optimal performance.
4.4 Sensitivity Analysis
[How do results vary with hyperparameters, dataset characteristics, etc.?]
Figure 3: Sensitivity to [parameter]
[Graph showing performance vs. parameter value]4.5 Qualitative Analysis (optional)
[Examples, case studies, error analysis]
---
5. Related Work
<!-- Position your work (can also be Section 2) (1-1.5 pages) -->
5.1 [Category 1 of Related Work]
[Thematic grouping of related work]
Work in this area includes [citations]. These approaches focus on [approach]. [Your work comparison].
5.2 [Category 2 of Related Work]
[Another thematic grouping]
5.3 [Category 3 of Related Work]
[Third grouping]
Summary: Unlike [prior work] which [limitation], our work [key difference] enabling [advantage].
---
6. Discussion (optional, can merge with Results or Conclusion)
<!-- Broader context, implications, limitations -->
Implications: [What do these results mean for the field?]
Limitations: This work has several limitations:
- [Limitation 1]: [Impact and potential mitigation]
- [Limitation 2]: [Impact and potential mitigation]
Future Directions: [Promising next steps]
---
7. Conclusion
<!-- Concise summary (0.5 page) -->
[Problem restatement:] This paper addressed [problem].
[Approach summary:] We proposed [approach] which [key innovation].
[Results summary:] Experiments on [datasets] demonstrated [main finding], achieving [performance metric].
[Impact statement:] This work [broader significance].
[Future outlook:] Future work will explore [direction].
---
Acknowledgments
We thank [people/institutions] for [contribution]. This research was supported by [funding agency, grant number].
---
References
<!-- Numbered style for CS conferences (IEEE, ACM) --> [1] Author 1, Author 2. "Title." Conference/Journal, Year.
[2] Author 3. "Title." Venue, Year.
[...]
---
Appendix A: Additional Proofs
[Full proofs of theorems if not included in main text]
Appendix B: Additional Experiments
[Supplementary experimental results]
Appendix C: Implementation Details
[Additional implementation details for reproducibility]
---
Author Checklist (Remove before submission)
Content:
- [ ] Clear problem statement in intro
- [ ] Contributions list is specific and measurable
- [ ] Algorithm/approach is clearly explained
- [ ] Sufficient detail for reproducibility
- [ ] Experimental setup is thorough
- [ ] All baselines are state-of-the-art
- [ ] Ablation studies justify design choices
- [ ] Limitations are acknowledged
Writing:
- [ ] Abstract is self-contained
- [ ] All figures/tables referenced in text
- [ ] All claims have evidence
- [ ] Technical terms defined on first use
- [ ] Consistent notation throughout
- [ ] No grammatical errors
Formatting:
- [ ] Follows venue template
- [ ] Within page limit
- [ ] References formatted correctly
- [ ] Figures are readable
- [ ] Code/data URL included
- [ ] Supplementary material uploaded
Ethics:
- [ ] Proper attribution of prior work
- [ ] No overclaiming
- [ ] Negative results reported
- [ ] Reproducibility information included
- [ ] Broader impacts discussed (if required)
Paper Writing Templates and Assets
This folder contains ready-to-use templates for different types of academic papers.
Available Templates
1. research-paper-template.md
Standard IMRAD research paper template suitable for experimental sciences, engineering, and empirical computer science.
2. conference-paper-template.md
Template optimized for computer science conferences (ACM, IEEE, etc.).
3. literature-review-template.md
Comprehensive template for survey and literature review papers.
4. short-paper-template.md
Template for workshop papers, extended abstracts, and 2-4 page submissions.
Usage
1. Copy the appropriate template to your working directory 2. Rename to your paper title 3. Fill in the sections following the guidance in comments 4. Remove placeholder text and instructions as you write 5. Refer to the references/ folder for detailed writing guidance
Customization
These templates provide structure and guidance but should be adapted to:
- Your specific venue requirements
- Your discipline's conventions
- Your paper's unique needs
- Your target journal/conference style
Always check venue-specific requirements for:
- Page limits
- Section requirements
- Citation formats
- Figure/table styles
- Formatting specifications
[Your Paper Title]: [Subtitle if Needed]
Authors: [Author1 Name¹, Author2 Name², Author3 Name¹]
Affiliations:
- ¹ Department, Institution, City, Country
- ² Department, Institution, City, Country
Corresponding Author: email@domain.com
---
Abstract
<!-- 150-250 words --> <!-- Include: Background (1-2 sentences), Gap (1 sentence), Objective (1 sentence), --> <!-- Methods (1-2 sentences), Results (2-3 sentences), Conclusion (1 sentence) -->
[Background: Describe the broad problem area and why it matters]
[Gap: State what's missing or problematic in current approaches]
[Objective: Clearly state what this paper investigates]
[Methods: Briefly describe your approach]
[Results: Summarize key findings with specific numbers]
[Conclusion: State the main takeaway and implications]
Keywords: keyword1, keyword2, keyword3, keyword4, keyword5
---
1. Introduction
<!-- Hook readers with why this problem matters --> <!-- Establish context → Problem → Gap → Your contribution --> <!-- Aim for 1-2 pages -->
[Opening paragraph: Hook and broad context]
[Paragraphs 2-3: Narrow the context, establish the problem and its significance]
[Paragraph 4: Research gap - what's missing in current work]
[Paragraph 5: Your contribution] We make the following contributions:
- Contribution 1: [Describe first main contribution]
- Contribution 2: [Describe second main contribution]
- Contribution 3: [Describe third main contribution]
[Optional paragraph: Paper organization] The remainder of this paper is organized as follows. Section 2 reviews related work. Section 3 describes our methodology. Section 4 presents experimental results. Section 5 discusses implications and limitations. Section 6 concludes and outlines future work.
---
2. Related Work
<!-- Organize thematically, not chronologically --> <!-- Compare and contrast approaches --> <!-- Position your work clearly --> <!-- Aim for 1-2 pages -->
2.1 [Thematic Area 1]
[Describe first category of related work] [Group similar papers and discuss their approaches] [Highlight strengths and limitations]
Key work in this area includes [citations], which focus on [approach]. While these methods achieve [strength], they are limited by [limitation].
2.2 [Thematic Area 2]
[Describe second category of related work]
2.3 [Thematic Area 3]
[Describe third category of related work]
2.4 Positioning This Work
Our work differs from existing approaches in several key ways:
- [Key difference 1]
- [Key difference 2]
- [Key difference 3]
---
3. Methods
<!-- Provide enough detail for replication --> <!-- Justify design choices --> <!-- Include diagrams for complex procedures --> <!-- Aim for 2-3 pages -->
3.1 Overview
[High-level description of your approach] [What makes it novel or different?]
3.2 Experimental Design
Research Questions:
- RQ1: [First research question]
- RQ2: [Second research question]
- RQ3: [Third research question]
Hypotheses:
- H1: [First hypothesis]
- H2: [Second hypothesis]
3.3 Materials / System Description
[Describe the system, tools, datasets, or materials used] [Include specifications, versions, configurations]
3.4 Procedure
[Step-by-step description of what you did] [Detailed enough for someone to replicate]
1. Step 1: [Description] 2. Step 2: [Description] 3. Step 3: [Description]
3.5 Data Collection
[How data was collected] [Sample size, timeframe, collection methods] [Any preprocessing or cleaning steps]
3.6 Analysis Methods
[Statistical or analytical methods used] [Tools and software] [Significance levels, confidence intervals, etc.]
---
4. Results
<!-- Present findings objectively without interpretation --> <!-- Use tables and figures effectively --> <!-- Aim for 2-3 pages -->
4.1 [Finding Category 1]
[Present first set of results] [Reference figures and tables] [Report specific numbers, statistics]
Table 1 shows [description]. We observed [finding] with [statistical significance].
Table 1: [Caption describing what the table shows]
| Condition | Metric 1 | Metric 2 | Metric 3 | p-value |
|---|---|---|---|---|
| Control | X.XX | X.XX | X.XX | - |
| Treatment A | X.XX | X.XX | X.XX | <.001 |
| Treatment B | X.XX | X.XX | X.XX | <.01 |
4.2 [Finding Category 2]
[Present second set of results]
Figure 1 illustrates [description]. The results show [observation].
Figure 1: [Caption explaining what the figure shows]
[Include figure here or describe where it would go]4.3 [Finding Category 3]
[Present third set of results]
4.4 Summary
[Brief summary of main findings]
- Finding 1: [Summary with key number]
- Finding 2: [Summary with key number]
- Finding 3: [Summary with key number]
---
5. Discussion
<!-- Interpret results in context --> <!-- Compare with previous work --> <!-- Acknowledge limitations --> <!-- Aim for 2-3 pages -->
5.1 Interpretation of Results
[What do the results mean?] [How do they address your research questions?]
Our findings demonstrate that [interpretation]. This is significant because [reason].
Addressing Research Questions:
- RQ1: Our results show that [answer to RQ1]
- RQ2: The data indicate that [answer to RQ2]
- RQ3: We found evidence that [answer to RQ3]
5.2 Comparison with Previous Work
[How do your results compare with related work?] [Agreements and disagreements]
Our findings align with [previous work] in showing [agreement]. However, they differ from [other work] which reported [difference]. This discrepancy may be due to [explanation].
5.3 Implications
Theoretical Implications: [What do these findings mean for theory?]
Practical Implications: [What are the real-world applications?]
Methodological Implications: [What do these findings suggest about methods?]
5.4 Limitations
[Honest acknowledgment of weaknesses] [Why they don't invalidate findings]
This study has several limitations:
- Limitation 1: [Description and why it doesn't invalidate findings]
- Limitation 2: [Description and why it doesn't invalidate findings]
- Limitation 3: [Description and why it doesn't invalidate findings]
5.5 Future Work
[Specific next steps based on findings] [Open questions]
Future research should address [direction 1]. Additionally, it would be valuable to investigate [direction 2].
---
6. Conclusion
<!-- Restate key contributions --> <!-- Summarize main findings --> <!-- End with strong closing --> <!-- Aim for 0.5-1 page -->
[Paragraph 1: Restate the problem and your approach] This paper addressed the problem of [problem] by [approach].
[Paragraph 2: Summarize main findings] Our experiments demonstrated [main finding 1], [main finding 2], and [main finding 3].
[Paragraph 3: Broader implications] These findings have important implications for [area]. They suggest that [implication].
[Paragraph 4: Future directions] Future work will explore [direction], with the goal of [objective].
[Final sentence: Strong closing statement] [Leave readers with the key takeaway]
---
Acknowledgments
We thank [people] for [contribution]. This work was supported by [funding source, grant number].
---
References
<!-- Use consistent citation format (APA, IEEE, etc.) --> <!-- Include all and only cited works --> <!-- Alphabetical order for author-date styles --> <!-- Numerical order for numbered styles -->
1. [Reference 1] 2. [Reference 2] 3. [Reference 3] ...
---
Appendices
Appendix A: [Additional Materials]
[Supplementary information that doesn't fit in main text] [Detailed procedures, additional data, etc.]
Appendix B: [Supplementary Data]
[Additional tables, figures, or analyses]
---
Notes for Authors
Before removing this section:
1. ✅ Fill in all bracketed placeholders 2. ✅ Remove all instructional comments (<!-- -->) 3. ✅ Adjust section structure to match venue requirements 4. ✅ Add/remove sections as needed for your content 5. ✅ Check that all figures/tables are referenced in text 6. ✅ Verify all citations are in references 7. ✅ Format according to venue style guide 8. ✅ Run through revision checklist in references/REFERENCE.md
Remember:
- This is a template, not a rigid structure
- Adapt to your specific needs and venue requirements
- Quality over quantity - don't force content into sections
- Refer to references/ folder for detailed guidance on each aspect
MIT License
Copyright (c) 2026 Claude Code Community
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
---
ATTRIBUTION NOTE:
This skill incorporates insights and guidelines from multiple sources:
1. Academic Writing Best Practices from:
- APA Publication Manual (7th Edition)
- IEEE Editorial Style Manual
- Various academic institutions (Ohio University, Duke, MIT, USC, etc.)
2. "Rules for Writing Elite Information Systems Papers" by Jason Bennett Thatcher
- Used with appreciation for advancing academic writing pedagogy
- Not an endorsement by Professor Thatcher
3. General academic writing resources cited in the skill documentation
This skill is provided as an educational tool for improving academic writing.
Users should cite original sources appropriately in their own work.
Writing Elite Information Systems Papers
Based on Thatcher's 17 Rules for Elite Journal Papers
This guide distills best practices for writing theoretically grounded, construct-centered, mid-range empirical papers that make clear contributions to elite Information Systems journals (MISQ, ISR, JMIS, JAIS).
---
The 17 Rules for Elite Papers
Phase 1: Framing the Paper
Rule 1: Open with Bold Claims or Puzzles
Start with a theoretically meaningful claim or empirical puzzle that anchors your contribution.
Good Opening: "This paper shows that CIO presence, often ignored in emerging markets, substantially predicts a firm's AI orientation."
Bad Opening: "The IS field has long been interested in digital transformation."
How to Know You're Doing It Well:
- Your first sentence makes a clear, theoretically meaningful claim
- The introduction passes the "skim test" - readers know what, why, and contribution
- Your introduction and conclusion align - they "rhyme"
Rule 2: Use Narrative Hooks
Introduce compelling puzzles, contradictions, or paradoxes early.
Example: "Despite spending billions on AI, many firms fail to adopt it strategically. Why? We show that the answer lies in whether the CIO has a seat at the table."
How to Know:
- First paragraph introduces tension/contradiction
- Readers ask "why?" not just "what?"
- The hook reverberates across the manuscript
Rule 3: Lead with the Contribution
Every section and paragraph should open with the most important point.
Good Example: "We define IT mindfulness as a user's dynamic capability and validate its influence on task adaptation and feature use."
Bad Example: "With the growing use of information systems, researchers have become increasingly interested in user attitudes."
Practical Tips:
- Start with "We found..." not "We ran..."
- Abstract begins with what you do and find, not gaps
- Read only first sentences - does the argument make sense?
Rule 4: One Construct, One Paragraph
Each focal construct needs: (a) one-sentence definition, (b) boundary clarification, (c) placement in nomological network.
Example: "IT mindfulness is a user's dynamic capability to notice new information, remain contextually aware, and adjust IT use intentionally."
Practical Tips:
- Write definition first, then what it's NOT
- Each construct gets its own paragraph
- Use same label across all sections
Rule 5: Thread the Construct
Use the same term, label, and framing throughout.
Before (Inconsistent):
- Abstract: "IT mindfulness"
- Theory: "technological awareness"
- Hypotheses: "tech attentiveness"
- Discussion: "IT flexibility"
After (Consistent):
- Use "IT mindfulness" everywhere
Practical Tips:
- Use Control-F to scan for inconsistencies
- Match terms in hypotheses with figures and tables
- Create style sheet for coauthors
---
Phase 2: Building the Argument
Rule 6: Use Parallel Logic
Follow AB → BC → CD chains. Each paragraph: setup → action → implication.
Structure:
- Theory: "IT mindfulness reduces strain and enhances adaptation"
- Hypothesis: "H1: IT mindfulness reduces digital strain"
- Method: "Used IT mindfulness scale (Thatcher et al., 2018)"
- Results: "IT mindfulness significantly predicts lower strain"
- Discussion: "Results support that IT mindfulness buffers stress"
Rule 7: Link Back to Mechanisms
Explain WHY effects occur, not just that they occurred.
Good: "The effect of IT identity on feature exploration is driven by internalization: when users see IT as part of who they are, they seek out new capabilities to maintain self-coherence."
Bad: "Users with strong IT identity explored more features."
Rule 8: Theorize, Don't Speculate
Turn limitations into boundary conditions. Avoid vague "future research" claims.
Good: "Our findings indicate that IT identity amplifies digital self-efficacy only when organizational structures allow autonomy. Future research could test whether identity-based motivation weakens in highly centralized settings."
Bad: "Future research should examine how IT identity interacts with other factors."
Rule 9: Model the Journal
Align tone, structure, and rhetorical flow with target journal exemplars.
How:
- Reverse-engineer 3-5 recent papers from target journal
- Map section flow, headings, paragraph function
- Match theoretical cadence and contribution framing
---
Phase 3: Executing Methods & Results
Rule 10: Frame Empirics as Theory Tests
Report results as tests of mechanisms, not procedures.
Good: "Shielding moderated the effect of stress on performance (β = −.21, p < .01), supporting the idea that real-time capacity dampens strain-related impairment."
Bad: "We ran a regression to test H3 and found a significant effect (p < .05)."
Rule 11: The Gordon Davis Rule
Use visuals to show models, results, and robustness checks.
Requirements:
- Model figure clearly labeled
- Results table self-contained
- Robustness checks visible
- Captions explain what's tested and how to read
Rule 12: Show Everything That Matters
Every robustness check in a table. Every model in a figure. Every citation complete.
Three-Part Structure: 1. Measurement quality (α/CR ≥ .70; loadings ≥ .60; AVE ≥ .50) 2. Structural model (effect sizes + 95% CIs) 3. Robustness (alternative specs, subsample tests)
---
Phase 4: Writing with Clarity
Rule 13: Compress Without Hollowing
Write dense, clear prose. Remove redundancy while retaining insight.
Template: Mechanism → effect size + 95% CI → boundary → stability
Example: "Overload increases work–life conflict, lowering mobile IT use (indirect = X, 95% CI [Y, Z]); control weakens this pathway (moderation index = A, 95% CI [B, C]); effects hold across specifications."
Rule 14: Avoid Stylistic Clutter
Eliminate hedges, nominalizations, metadiscourse, "shudder quotes."
What to Avoid:
- Hedges: "might," "may," "could," "suggests," "appears to"
- Nominalizations: "utilization" → "use"
- Shudder quotes: unnecessary quotes around common terms
- Metadiscourse: "This paper explores..." → "We explore..."
Hemingway Pass:
- Short sentences (14-18 words average)
- Active voice (passive <10%)
- Strong verbs, concrete subjects
- One idea per sentence
---
Phase 5: Surviving Review & Living On
Rule 15: Write for Reviewers
Make it easy to say yes. Preempt concerns with clean structure, footnotes, transparent tables.
How:
- Clean section headers
- Summary tables for key results
- Footnotes explaining design choices
- Every claim backed by table/figure
Rule 16: End with Resonance
Close by reinforcing core contribution. Don't apologize or hedge.
Good: "By showing that CIO presence influences AI orientation, this paper identifies a concrete lever firms can adjust as they confront strategic uncertainty around AI."
Bad: "Although this study has limitations, more research is needed to understand the long-term impact of CIOs."
Rule 17: Make the Paper Easy to Teach
Build clarity and portability into your model, construct, and logic.
How to Know:
- A colleague can explain your model on whiteboard in 3 minutes
- Your construct definition is memorable
- Instructors could reuse your visuals or examples
---
Bonus Principles from Mentors
The May Maxim
"Write so scholars will cite it, but others will understand it."
Tips:
- Define constructs plainly
- Use discipline-neutral examples
- Strip excess metadiscourse
- Test abstract on non-expert
The Pascoe Principle
"You don't wait for inspiration. You show up. You write."
Tips:
- Daily writing routine
- Revise previous day's work first
- Set minimum daily output
- Make writing first priority of workday
The George Law
"Don't waste your advisor's time. Come prepared. Be clear. Move the work forward."
Tips:
- Never submit messy drafts
- Structure every meeting with agenda
- Summarize takeaways after meetings
- Check in frequently, meet purposefully
---
Quick Diagnostic Checklist
Before Submission
Structure:
- [ ] Topic sentences form coherent argument
- [ ] Construct labels consistent throughout
- [ ] Figures and tables self-contained
Theory:
- [ ] Contribution stated clearly in opening
- [ ] Each construct defined in own paragraph
- [ ] Mechanisms named for every effect
- [ ] Parallel logic throughout
Evidence:
- [ ] Results frame as theory tests
- [ ] Effect sizes with 95% CIs reported
- [ ] Robustness checks in summary table
- [ ] All visuals match text labels
Style:
- [ ] Hemingway pass complete (hedges removed)
- [ ] Active voice >90%
- [ ] Nominalizations converted to verbs
- [ ] Average sentence 14-18 words
Conclusion:
- [ ] Mirrors opening claim
- [ ] States what field now knows
- [ ] No apologetic hedging
- [ ] Boundaries clearly stated
---
The Common Diagnostics Box
Run these mechanical checks before submission:
Pass A - Structure (10-20 min)
1. Topic-Sentence Ladder: Copy first sentence of each paragraph - should tell coherent story 2. Control-F Label Audit: Search construct names - must match everywhere
Pass B - Theory (20-30 min)
3. Contribution Clarity: One-sentence contribution at top of Abstract and Intro 4. Mechanism Naming: Every effect has "because [mechanism]" clause 5. Scope Sentence: Discussion closes with knowledge claim + boundaries
Pass C - Evidence (30-40 min)
6. Visuals as Evidence: Model figure + results table self-contained 7. Measurement ↔ Definition: Items reflect definition phrases 8. Robustness at a Glance: One summary table for all checks 9. Magnitude + Uncertainty: Direction + effect size + CI for all effects
Pass D - Style (10-15 min)
10. Hemingway Pass: Find/replace hedges, convert nominalizations, reduce passive
---
Paper Outline Template (MISQ Style)
Title Page
- Concise title naming core construct(s)
- Authors, affiliations, keywords
Abstract (150-250 words)
- Phenomenon, construct, method, findings, contribution
1. Introduction (1.5-2.5 pages)
- Hook (problem/paradox)
- Define key construct early
- Preview contribution
- Outline gap
- Roadmap
2. Theoretical Background
- 2.1 Focal Construct Definition
- 2.2 Differentiation from Related Constructs
- 2.3 Theoretical Model Overview
3. Hypothesis Development
- State clearly
- Use AB → BC → CD logic
- Include model diagram
4. Research Method
- 4.1 Design and Context
- 4.2 Measurement
- 4.3 Data Collection
- 4.4 Analytical Strategy
5. Results
- 5.1 Measurement Model Validation
- 5.2 Hypothesis Tests
- 5.3 Robustness Checks
6. Discussion
- Interpret pattern
- Revisit mechanisms
- Address nulls/unexpected
- Theoretical contributions
- Practical implications
7. Conclusion
- Restate contribution
- Emphasize advancement
- Boundary conditions
- Theory-grounded future research
References
Figures and Tables
- Figure 1: Theoretical model
- Figure 2: Interactions/extended model
- Table 1: Measurement (items, loadings)
- Table 2: Validity (AVE, CR, HTMT)
- Table 3: Main results
- Table 4: Mediation/moderation
- Table 5: Robustness summary
Appendices
- A: Construct Development
- B: Measurement Validation
- C: Main Model Estimation
- D: Robustness Checks
- E: Supplementary Materials
---
Key Insights for Elite Papers
What Makes a Paper "Elite"? 1. Clear contribution - stated early, threaded throughout, reinforced at end 2. Construct clarity - precise definitions, clear boundaries, consistent labeling 3. Mechanism-based theory - explains WHY, not just WHAT 4. Rigorous empirics - theory-driven tests, effect sizes + CIs, comprehensive robustness 5. Tight writing - compressed without hollowing, active voice, minimal hedging 6. Teachability - others can easily explain and use your model
Common Mistakes to Avoid:
- Starting with literature review instead of claim
- Inconsistent construct labeling
- Reporting procedures instead of theory tests
- Burying contribution
- Vague "future research" instead of bounded extensions
- Apologetic conclusions
- Missing robustness checks
- Hedging when you have evidence
The Hourglass Structure:
- Broad opening: Why this matters (introduction)
- Narrow middle: Precise theory and tests (theory, methods, results)
- Broad closing: What this means (discussion, conclusion)
Remember:
- Good papers go through multiple revisions
- Writing is rewriting
- Daily production is the engine of contribution
- Show up, revise, finish
---
Additional Resources
Core Readings:
- Bem (1987) - Hourglass model
- Starbuck (1999) - Bold openings, topic sentences
- Cochrane (2005) - Parallel logic, concise prose
- Pinker (2014) - Stylistic clarity
- Suddaby (2010) - Construct clarity
For PhD Students:
- Booth et al. (2016) - The Craft of Research
- Sword (2012) - Stylish Academic Writing
- Graff & Birkenstein (2018) - They Say / I Say
Journal Resources:
- MISQ author guidelines
- ISR editorial comments
- JMIS submission requirements
- JAIS author resources
---
This guide synthesizes decades of lessons from elite IS scholars. Use it to structure your paper, sharpen your contribution, and avoid common mistakes. As you mature, you'll learn when to adapt these rules to your voice and context.
The papers that endure are teachable, readable, and trustworthy. Write the kind of paper reviewers want to accept and scholars want to cite.
Academic Paper Writing Reference Guide
This comprehensive reference provides detailed guidelines for writing high-quality academic papers. Load this document when you need in-depth guidance on specific writing challenges.
Table of Contents
1. Argument Construction 2. Evidence and Citations 3. Writing Style and Clarity 4. Common Formatting Standards 5. Peer Review and Revision 6. Ethical Considerations 7. Advanced Techniques
---
Argument Construction
Building a Strong Thesis
A thesis or research question should be:
- Specific: Not "AI is useful" but "Transformer architectures reduce training time by 40% compared to RNNs for sequence-to-sequence tasks"
- Debatable: Others could reasonably disagree or take a different approach
- Significant: Addresses an important gap or problem
- Achievable: Can be supported within the scope of your paper
Logical Argumentation Patterns
Deductive Reasoning
Major premise: All neural networks require training data
Minor premise: GPT-4 is a neural network
Conclusion: GPT-4 requires training dataUse for: Applying general principles to specific cases
Inductive Reasoning
Observation 1: Algorithm A performs well on dataset X
Observation 2: Algorithm A performs well on dataset Y
Observation 3: Algorithm A performs well on dataset Z
Conclusion: Algorithm A generalizes well across datasetsUse for: Drawing general conclusions from specific observations
Comparative Analysis
Approach A: High accuracy, high computational cost
Approach B: Medium accuracy, low computational cost
Context: Resource-constrained deployment
Conclusion: Approach B is more suitable for this contextUse for: Evaluating trade-offs and making recommendations
Handling Counterarguments
Strong papers acknowledge and address potential objections:
1. Identify: What might critics say? 2. Present fairly: Don't create strawman arguments 3. Respond: Explain why the objection doesn't invalidate your work 4. Acknowledge limitations: Be honest about what your work doesn't address
Example:
"One might argue that our approach requires significant preprocessing overhead. While true, we demonstrate that this one-time cost is amortized across multiple queries, resulting in overall performance gains of 3x in production scenarios."
Maintaining Argumentative Thread
Every paragraph should:
- Connect to the central thesis
- Transition logically from the previous paragraph
- Lead naturally to the next point
Transition techniques:
- Sequential: "First... Second... Finally..."
- Causal: "As a result... Consequently... Therefore..."
- Comparative: "In contrast... Similarly... Unlike..."
- Elaborative: "Furthermore... Additionally... More specifically..."
---
Evidence and Citations
Types of Evidence
Empirical Evidence
- Experimental results
- Statistical data
- Case studies
- Measurements and observations
Theoretical Evidence
- Mathematical proofs
- Logical derivations
- Formal models
- Theoretical frameworks
Authoritative Evidence
- Published research
- Expert testimony
- Established standards
- Consensus findings
Citation Best Practices
When to Cite
- Direct quotations (always)
- Specific data or statistics
- Ideas or theories from others
- Methods or techniques you adapted
- Supporting evidence for claims
When NOT to Cite
- Common knowledge in your field
- Your own original ideas or findings
- Widely known facts
- General methodological approaches (e.g., "We used Python")
Citation Integration Styles
Signal Phrase (Author-prominent)
Smith et al. (2024) demonstrated that attention mechanisms improve performance by 15%.Use when: The author's identity or credibility matters
Parenthetical (Information-prominent)
Attention mechanisms improve performance by 15% (Smith et al., 2024).Use when: The information itself is more important than the source
Narrative Integration
Recent work on attention mechanisms has shown significant improvements, with some studies reporting gains up to 15% (Smith et al., 2024; Jones & Brown, 2023).Use when: Synthesizing multiple sources
Managing Citations
Primary vs. Secondary Sources
- Primary: Original research, first-hand data
- Secondary: Reviews, textbooks, summaries
- Prefer primary sources for specific claims
- Use secondary sources for background and synthesis
Citation Recency
- Recent work (last 2-3 years) for current state-of-the-art
- Classic papers for foundational concepts
- Balance: Show you know the field's history and current trends
Citation Diversity
- Include different research groups
- Represent different perspectives
- Avoid over-citing your own work
- Include work that challenges your approach
---
Writing Style and Clarity
The Ten Commandments of Clear Academic Writing
1. Prefer active voice: "We designed the algorithm" not "The algorithm was designed" 2. Use concrete subjects: "The model predicts" not "It can be seen that" 3. Eliminate needless words: "because" not "due to the fact that" 4. Define before using: Introduce acronyms and technical terms 5. One idea per sentence: Complex ideas need multiple sentences 6. One topic per paragraph: Each paragraph should have a clear focus 7. Use parallel structure: "We collected data, analyzed results, and drew conclusions" 8. Be specific: "The model achieved 94.2% accuracy" not "The model performed well" 9. Avoid nominalizations: "We investigated" not "An investigation was conducted" 10. Read aloud: If it's hard to read, it's hard to understand
Verb Tense Guidelines
Present Tense
- General truths: "Neural networks learn from data"
- Your paper's contents: "Section 3 presents the methodology"
- Figures and tables: "Figure 1 shows the architecture"
Past Tense
- Your specific research activities: "We collected 10,000 samples"
- Previous research: "Smith (2023) found that..."
- Your results: "The model achieved 95% accuracy"
Present Perfect
- Recent developments: "Researchers have explored various approaches"
- Research spanning to present: "Attention mechanisms have become standard"
Precision in Word Choice
Vague → Precise
- "fast" → "processes 1000 requests/second"
- "significant" → "p < 0.001"
- "many" → "73% of participants"
- "recently" → "in the last five years (2020-2025)"
- "small" → "8% reduction"
Hedging Appropriately
- Too weak: "It might possibly suggest that there could be..."
- Too strong: "This proves definitively that..."
- Just right: "These results suggest that..."
Appropriate hedges: suggest, indicate, appear, tend to, likely, may, might, possible
Paragraph Construction
Effective Paragraph Structure
[Topic Sentence] - States the main point
[Supporting Sentences] - Provide evidence, examples, analysis
[Transition/Conclusion] - Links to next paragraph or summarizesExample:
[Topic] Transfer learning significantly reduces training time for domain-specific tasks. [Support] Our experiments show that fine-tuning a pre-trained model requires only 20% of the data needed to train from scratch, reducing training time from 72 hours to 14 hours. [Support] This efficiency gain is consistent across three different domains: medical imaging, financial forecasting, and natural language processing. [Transition] However, the effectiveness of transfer learning depends critically on the similarity between source and target domains, as we explore in the next section.
---
Common Formatting Standards
APA Style (7th Edition)
In-text Citations
- Single author: (Smith, 2024)
- Two authors: (Smith & Jones, 2024)
- Three or more: (Smith et al., 2024)
Reference List
Journal Article:
Smith, J., Jones, M., & Brown, K. (2024). Title of article. Journal Name,
15(3), 234-256. https://doi.org/10.xxxx/xxxxx
Book:
Author, A. A. (2024). Title of book (2nd ed.). Publisher.
Conference Paper:
Smith, J. (2024). Paper title. In Proceedings of Conference Name (pp. 123-145).
Publisher.IEEE Style
In-text Citations
- Numbered: [1], [2], [3]
- Multiple: [1], [3], [5] or [1]-[4]
Reference List
Journal Article:
[1] J. Smith, M. Jones, and K. Brown, "Title of article," Journal Name,
vol. 15, no. 3, pp. 234-256, Mar. 2024.
Conference Paper:
[2] J. Smith, "Paper title," in Proc. Conference Name, City, Country, 2024,
pp. 123-145.Chicago Style
Notes-Bibliography System
- Footnotes or endnotes for citations
- Bibliography at end
Author-Date System
- Similar to APA
- Used more in sciences
Common Elements Across Styles
Equations
- Number consecutively: (1), (2), (3)
- Reference in text: "As shown in Equation 1..."
- Center important equations
- Define all variables
Figures and Tables
- Number by type: Figure 1, Table 1
- Captions should be self-explanatory
- Reference before appearance: "...as shown in Figure 1."
- Maintain consistent style
Sections
- Number hierarchically: 1, 1.1, 1.1.1
- Use consistent heading styles
- Don't go deeper than 3 levels typically
---
Peer Review and Revision
Understanding Reviewer Feedback
Types of Reviews
Major Revisions
- Fundamental issues with methodology, claims, or contribution
- Missing related work or context
- Insufficient evidence
- Require substantial rewriting
Minor Revisions
- Clarity issues
- Presentation problems
- Missing details
- Require polishing
Reject
- Out of scope
- Fundamental flaws
- Insufficient contribution
- May be resubmittable elsewhere
Responding to Reviews
General Principles 1. Stay professional: Never defensive or dismissive 2. Address every comment: Even if you disagree 3. Be specific: "We added Section 3.2" not "We clarified this" 4. Show changes: Mark revisions clearly 5. Thank reviewers: They donated their time
Response Letter Structure
Dear Editor,
Thank you for the opportunity to revise our manuscript. We appreciate
the reviewers' thoughtful feedback and believe it has significantly
strengthened our work.
Below, we address each comment point-by-point. Reviewer comments are in
italics, and our responses follow in regular text.
Reviewer 1:
*Comment 1: The related work section is incomplete.*
Response: We have expanded the related work section (Section 2) to include
15 additional papers covering recent developments in X, Y, and Z. The new
content appears on pages 3-5 (marked in blue in the revised manuscript).
[Continue for all comments...]
Sincerely,
[Authors]Self-Review Checklist
Before submission, review your own paper as if you were a peer reviewer:
Content Review
- [ ] Is the contribution clear and significant?
- [ ] Are all claims supported by evidence?
- [ ] Is the methodology sound and reproducible?
- [ ] Are results presented objectively?
- [ ] Are limitations acknowledged?
- [ ] Is related work comprehensive and fair?
Presentation Review
- [ ] Is the abstract accurate and complete?
- [ ] Does the introduction motivate the problem?
- [ ] Are sections organized logically?
- [ ] Are figures and tables clear and necessary?
- [ ] Are transitions smooth?
- [ ] Is the writing clear and concise?
Technical Review
- [ ] Are all references cited and formatted correctly?
- [ ] Are all figures/tables referenced in text?
- [ ] Are equations numbered and defined?
- [ ] Is formatting consistent throughout?
- [ ] Are there any typos or grammatical errors?
- [ ] Does it meet venue requirements?
---
Ethical Considerations
Research Ethics
Data Collection
- Obtain appropriate IRB approval for human subjects
- Ensure informed consent
- Protect participant privacy
- Handle data securely
Reporting Results
- Report all results, not just favorable ones
- Don't cherry-pick data
- Acknowledge failed experiments
- Be transparent about limitations
Reproducibility
- Provide sufficient methodological detail
- Share code and data when possible
- Report random seeds and hyperparameters
- Describe computing resources used
Authorship
Who Should Be an Author? Authors should have made substantial contributions to: 1. Conception or design, OR data acquisition/analysis 2. Drafting or critical revision 3. Final approval of the version 4. Agreement to be accountable for the work
Author Order
- First author: Primary contributor
- Last author: Often senior advisor (field-dependent)
- Middle authors: By contribution level
- Corresponding author: Handles communication
Acknowledgments Thank those who contributed but don't meet authorship criteria:
- Funding sources
- Technical assistance
- Helpful discussions
- Data providers
Citation Ethics
Plagiarism Never acceptable:
- Copying text without quotation marks and citation
- Paraphrasing without citation
- Using others' ideas without credit
Self-Plagiarism Avoid:
- Republishing the same work in multiple venues
- Copying large sections from your own published work
- Presenting the same results as new
Acceptable: Building on your own prior work with proper citation
Conflicts of Interest
Disclose:
- Financial interests in outcomes
- Relationships with funders
- Competing interests
- Dual affiliations
---
Advanced Techniques
Writing for International Audiences
Clarity First
- Avoid idioms: "ballpark figure" → "approximate value"
- Use simple vocabulary when possible
- Define cultural references
- Be explicit rather than relying on shared context
Cultural Sensitivity
- Avoid culturally specific examples without explanation
- Use international units (metric system)
- Be inclusive in examples and language
- Consider different academic writing conventions
Effective Literature Synthesis
Beyond Listing Don't just summarize each paper separately. Instead:
Thematic Organization
❌ Smith (2023) did X. Jones (2024) did Y. Brown (2024) did Z.
✅ Recent approaches to problem X fall into three categories. First,
optimization-based methods (Smith, 2023; Lee, 2024) focus on... Second,
learning-based approaches (Jones, 2024) leverage... Finally, hybrid
methods (Brown, 2024; Taylor, 2023) combine...Critical Analysis
❌ Many researchers have studied this problem.
✅ While optimization methods achieve high accuracy (Smith, 2023), they
scale poorly to large datasets (Jones, 2024). Learning-based approaches
address scalability but sacrifice theoretical guarantees (Brown, 2024).
Our work bridges this gap by...Writing with Co-Authors
Version Control
- Use Git for LaTeX documents
- Use track changes for Word documents
- Clearly mark who wrote what initially
Consistent Voice
- Designate one author to do final editorial pass
- Agree on terminology and style guide
- Use the same tense and person throughout
Division of Labor
- Assign sections to authors with relevant expertise
- One person writes each section initially
- All authors review and revise all sections
- Final integration by lead author
Managing Long Documents
Modular Writing
- Write each section in separate file
- Use LaTeX
\input{}or similar - Makes collaboration easier
- Easier to reorganize
Consistent Notation
- Create notation table early
- Use macro definitions in LaTeX
- Don't reuse symbols for different meanings
- Define all notation on first use
Document Structure
paper/
├── main.tex
├── sections/
│ ├── abstract.tex
│ ├── introduction.tex
│ ├── related-work.tex
│ ├── method.tex
│ ├── experiments.tex
│ ├── discussion.tex
│ └── conclusion.tex
├── figures/
├── tables/
├── bibliography.bib
└── macros.texWriting Under Time Pressure
Prioritization 1. Must-have: Core contribution, key results, basic structure 2. Should-have: Complete related work, all experiments, polished writing 3. Nice-to-have: Additional analyses, perfect formatting, extensive discussion
Efficient Workflow
- Set daily word/section targets
- Write first, edit later (separate phases)
- Use templates and previous papers as starting points
- Focus on getting complete draft before perfecting
Time Allocation Example (for 2-week deadline)
- Days 1-2: Outline and figure planning
- Days 3-6: First complete draft
- Days 7-9: Revision for content and structure
- Days 10-12: Revision for clarity and style
- Days 13-14: Final polish and formatting
---
Quick Reference Tables
Common Academic Phrases
| Purpose | Phrases |
|---|---|
| Introducing | "This paper presents...", "We propose...", "This work investigates..." |
| Contrasting | "However,", "In contrast,", "On the other hand,", "Conversely," |
| Supporting | "Furthermore,", "Moreover,", "Additionally,", "Similarly," |
| Concluding | "Therefore,", "Thus,", "Consequently,", "As a result," |
| Hedging | "suggests", "indicates", "appears to", "may", "likely" |
| Emphasizing | "notably", "particularly", "significantly", "crucially" |
Section Length Guidelines (for 8-page paper)
| Section | Pages | Proportion |
|---|---|---|
| Abstract | 0.25 | 3% |
| Introduction | 1.0 | 12.5% |
| Related Work | 1.0 | 12.5% |
| Methodology | 1.5 | 18.75% |
| Experiments | 1.5 | 18.75% |
| Results | 1.0 | 12.5% |
| Discussion | 1.0 | 12.5% |
| Conclusion | 0.5 | 6.25% |
| References | 0.25 | 3% |
Adjust based on paper type and venue requirements
Revision Checklist
| Pass | Focus | What to Check |
|---|---|---|
| 1 | Structure | Logical flow, section organization, argument coherence |
| 2 | Content | Evidence sufficiency, citation accuracy, completeness |
| 3 | Clarity | Sentence structure, word choice, jargon elimination |
| 4 | Style | Voice consistency, tense agreement, parallel structure |
| 5 | Format | Citation format, figure/table numbering, formatting requirements |
| 6 | Polish | Grammar, spelling, punctuation, typos |
---
Further Resources
Writing Guides
- Strunk & White, "The Elements of Style" (classic reference)
- Williams & Bizup, "Style: Lessons in Clarity and Grace"
- Sword, "Stylish Academic Writing"
- Booth et al., "The Craft of Research"
Field-Specific Guides
- Computer Science: "Writing for Computer Science" by Zobel
- Sciences: "A Short Guide to Writing About Science" by Porush
- Social Sciences: APA Publication Manual
- Engineering: IEEE Editorial Style Manual
Online Resources
- Purdue OWL (Online Writing Lab): Comprehensive writing resources
- Duke Graduate School Writing Studio: Discipline-specific guides
- MIT Communication Lab: Technical writing guidance
---
Remember
Good academic writing is:
- Clear: Readers understand your ideas easily
- Concise: Every word serves a purpose
- Accurate: Claims are supported and precise
- Organized: Logical flow from idea to idea
- Ethical: Honest, attributed, and responsible
The goal is to communicate your research effectively so others can understand, evaluate, and build upon your work.
Paper Structure Templates
This document provides detailed structural templates for different types of academic papers. Use these as starting points and adapt to your specific venue requirements.
Table of Contents
1. Research Article (IMRAD) 2. Computer Science Conference Paper 3. Literature Review / Survey Paper 4. Position Paper / Perspective 5. Technical Report 6. Thesis Chapter 7. Short Paper / Extended Abstract
---
Research Article (IMRAD)
Standard format for experimental sciences, engineering, and empirical computer science
Structure
Title
Authors and Affiliations
Abstract (150-250 words)
Keywords (4-6 terms)
1. Introduction (1-2 pages)
1.1 Background and Context
1.2 Problem Statement
1.3 Research Questions/Hypotheses
1.4 Contributions
1.5 Paper Organization
2. Related Work (1-2 pages)
2.1 [Thematic Area 1]
2.2 [Thematic Area 2]
2.3 [Thematic Area 3]
2.4 Positioning This Work
3. Methods (2-3 pages)
3.1 Overview
3.2 Experimental Design
3.3 Materials/System Description
3.4 Procedure
3.5 Data Collection
3.6 Analysis Methods
4. Results (2-3 pages)
4.1 [Finding 1]
4.2 [Finding 2]
4.3 [Finding 3]
4.4 Summary
5. Discussion (2-3 pages)
5.1 Interpretation of Results
5.2 Comparison with Previous Work
5.3 Implications
5.4 Limitations
5.5 Future Work
6. Conclusion (0.5-1 page)
Acknowledgments
References
Appendices (optional)Content Guidelines
Abstract Template
[Background - 1-2 sentences]: What's the broad problem area?
[Gap - 1 sentence]: What's missing or problematic?
[Objective - 1 sentence]: What did you investigate?
[Methods - 1-2 sentences]: How did you do it?
[Results - 2-3 sentences]: What did you find?
[Conclusion - 1 sentence]: What does it mean?Introduction Flow
Paragraph 1: Hook and broad context
"Machine learning models are increasingly deployed in critical systems..."
Paragraph 2-3: Narrow the context, establish the problem
"However, existing approaches to model validation have three limitations..."
Paragraph 4: Research gap
"Despite extensive work on X and Y, the problem of Z remains unsolved..."
Paragraph 5: Your contribution
"This paper addresses this gap by presenting [your approach]. Specifically,
we make three contributions: (1)..., (2)..., (3)..."
Paragraph 6 (optional): Paper organization
"The remainder of this paper is organized as follows..."Methods Section Checklist
- [ ] Sufficient detail for replication
- [ ] Justification for design choices
- [ ] Clear description of variables/parameters
- [ ] Ethical approvals mentioned (if applicable)
- [ ] Statistical power analysis (if applicable)
- [ ] Diagrams of experimental setup
- [ ] Description of controls and baselines
Results Section Checklist
- [ ] Objective presentation (no interpretation)
- [ ] Clear connection to research questions
- [ ] Statistical significance reported
- [ ] Effect sizes provided
- [ ] Tables and figures with clear captions
- [ ] Both positive and negative results
- [ ] Raw data or summary statistics
Discussion Section Structure
Opening: Restate main findings briefly
Body paragraphs (each addresses one finding):
- State the finding
- Interpret it in context
- Compare with related work
- Explain implications
Limitations paragraph:
- Honest acknowledgment of weaknesses
- Why they don't invalidate findings
- How future work can address them
Future work paragraph:
- Specific next steps
- Open questions
- Broader directions---
Computer Science Conference Paper
Typical for ACM, IEEE, AAAI, NeurIPS, ICML, etc.
Structure
Title
Authors and Affiliations
Abstract (150-300 words)
1. Introduction (1-1.5 pages)
Problem motivation
Limitations of existing approaches
Key insight / core contribution
Main results summary
Contributions list
Paper roadmap (optional)
2. Background and Related Work (1-2 pages)
2.1 Problem Formulation
2.2 Related Approaches
2.2.1 [Category 1]
2.2.2 [Category 2]
2.3 Key Differences
3. Approach (2-3 pages)
3.1 Overview
3.2 [Component 1]
3.3 [Component 2]
3.4 Algorithm/Architecture
3.5 Theoretical Analysis (if applicable)
3.5.1 Complexity
3.5.2 Correctness
3.5.3 Convergence (if applicable)
4. Experimental Evaluation (2-3 pages)
4.1 Experimental Setup
4.1.1 Datasets
4.1.2 Baselines
4.1.3 Metrics
4.1.4 Implementation Details
4.2 Results
4.2.1 Main Results
4.2.2 Ablation Studies
4.2.3 Sensitivity Analysis
4.3 Discussion
5. Related Work (0.5-1 page, alternative placement)
[If not in Section 2]
6. Conclusion and Future Work (0.5 page)
References
Appendix (supplementary material)Content Guidelines
Contributions Format
We make the following contributions:
• We propose [novel technique X], which addresses [problem Y] by [key insight Z].
• We provide theoretical analysis showing [property A] and prove [bound B]
(Theorem 1).
• We demonstrate empirically that our approach outperforms state-of-the-art
methods by [X%] on [benchmark Y], while requiring [Z×] less computation
(Section 4).
• We release our implementation and datasets at [URL] to support reproducibility.Algorithm Presentation
Present in three levels:
1. High-level intuition (text):
"Our algorithm works by first preprocessing the data to identify key patterns,
then iteratively refining predictions based on confidence scores..."
2. Visual representation (diagram):
[Include system architecture or flowchart]
3. Formal specification (pseudocode):
Algorithm 1: [Name]
Input: ...
Output: ...
1: procedure NAME(parameters)
2: initialize ...
3: for each iteration do
4: ...
5: return resultExperimental Section Template
4.1 Experimental Setup
Datasets: We evaluate on three benchmark datasets:
• Dataset A: [brief description, size, characteristics]
• Dataset B: [brief description, size, characteristics]
• Dataset C: [brief description, size, characteristics]
Baselines: We compare against five state-of-the-art methods:
• Method 1 [Citation]: [one-line description]
• Method 2 [Citation]: [one-line description]
...
Metrics: We report:
• Accuracy: [definition and why it's appropriate]
• F1 Score: [definition and why it's appropriate]
• Runtime: [wall-clock time on specified hardware]
Implementation: We implemented our approach in Python using PyTorch.
Experiments ran on [hardware specs]. We used [optimizer] with learning
rate [X], batch size [Y], and trained for [Z] epochs. We report mean
and standard deviation over 5 runs with different random seeds.
4.2 Main Results
Table 1 shows results on all datasets. Our method achieves state-of-the-art
performance on X and Y, outperforming the best baseline by [N%] on average.
On dataset Z, we achieve comparable performance to [Method] while being
[M×] faster.
4.3 Ablation Studies
To understand which components contribute most to performance, we conduct
ablation studies (Table 2):
• Removing component A reduces accuracy by X%
• Removing component B reduces accuracy by Y%
• Combining both reduces accuracy by Z%
This demonstrates that both components are necessary...---
Literature Review / Survey Paper
For synthesizing and analyzing existing research in a field
Structure
Title
Authors and Affiliations
Abstract (200-300 words)
1. Introduction (1-2 pages)
1.1 Motivation and Scope
1.2 Research Questions
1.3 Methodology
1.4 Contributions
1.5 Organization
2. Background (1 page)
2.1 Key Concepts and Terminology
2.2 Historical Context
2.3 Problem Definition
3. Methodology (1 page)
3.1 Literature Search Strategy
3.2 Inclusion/Exclusion Criteria
3.3 Classification Framework
3.4 Analysis Approach
4. [Thematic Section 1] (2-4 pages)
4.1 [Subcategory A]
4.2 [Subcategory B]
4.3 Analysis and Comparison
4.4 Open Problems
5. [Thematic Section 2] (2-4 pages)
[Same structure as Section 4]
6. [Thematic Section 3] (2-4 pages)
[Same structure as Section 4]
7. Cross-Cutting Analysis (1-2 pages)
7.1 Common Themes
7.2 Trade-offs
7.3 Gaps in Literature
7.4 Emerging Trends
8. Future Directions (1-2 pages)
8.1 Open Problems
8.2 Promising Approaches
8.3 Research Opportunities
9. Conclusion (0.5-1 page)
References (extensive)Content Guidelines
Introduction Template
Paragraph 1: Why this topic matters
"Topic X has received significant attention due to [importance]..."
Paragraph 2: Scope and boundaries
"This survey covers work from [time period] on [specific aspects].
We focus on [included topics] but do not cover [excluded topics]..."
Paragraph 3: Methodology
"We identified papers through [search strategy], resulting in [N] papers
that met our criteria..."
Paragraph 4: Organization and contributions
"We organize the literature into [N] categories and make the following
contributions: (1)..., (2)..., (3)..."Thematic Section Template
4. [Category Name]
Opening paragraph: Define this category and explain its importance
4.1 [Subcategory A]
Work in this area focuses on [objective]. Key approaches include:
• Approach Type 1 [Citations]: These methods [description]. Representative
work includes [specific papers with brief descriptions].
Strengths: [bullet points]
Limitations: [bullet points]
• Approach Type 2 [Citations]: These methods [description]...
Strengths: [bullet points]
Limitations: [bullet points]
4.2 [Subcategory B]
[Same structure]
4.3 Comparison and Analysis
Table X compares approaches along [dimensions]. We observe:
• Finding 1: [analysis]
• Finding 2: [analysis]
• Finding 3: [analysis]
The main trade-off in this category is between [X] and [Y]...Comparison Table Template
Table 1: Comparison of [Category] Approaches
| Approach | Metrics | Scalability | Complexity | Year | Limitations |
|----------|---------|-------------|------------|------|-------------|
| Method A | 94.2% | O(n log n) | Medium | 2024 | Requires labeled data |
| Method B | 91.5% | O(n²) | High | 2023 | Not interpretable |
| Method C | 96.1% | O(n) | Low | 2024 | Limited to domain X |Future Directions Template
Based on our analysis, we identify the following promising research directions:
1. [Direction 1]: Current work has shown [progress], but significant gaps
remain in [area]. Addressing this would enable [benefit].
2. [Direction 2]: The trade-off between [X] and [Y] is fundamental. New
approaches that [strategy] could potentially achieve both.
3. [Direction 3]: Emerging trends in [area] suggest that [observation].
Applying these ideas to [context] may yield [outcome].---
Position Paper / Perspective
For presenting a viewpoint, critique, or vision for a field
Structure
Title (often provocative or question-based)
Authors and Affiliations
Abstract (150-200 words)
1. Introduction (0.5-1 page)
The claim/position stated clearly
Why it matters
Paper roadmap
2. Background and Context (1 page)
2.1 Current State of Affairs
2.2 Why This Is Problematic
2.3 Historical Perspective (optional)
3. The Case For [Your Position] (2-4 pages)
3.1 Argument 1
Evidence and reasoning
3.2 Argument 2
Evidence and reasoning
3.3 Argument 3
Evidence and reasoning
4. Addressing Counterarguments (1-2 pages)
4.1 Objection 1
Why it doesn't hold
4.2 Objection 2
Why it doesn't hold
4.3 Objection 3
Why it doesn't hold
5. Implications and Recommendations (1-2 pages)
5.1 For Researchers
5.2 For Practitioners
5.3 For the Field
6. Conclusion (0.5 page)
ReferencesContent Guidelines
Position Statement
Clear and bold:
✅ "We argue that the field's focus on benchmark performance has led to
fundamental misunderstandings about model capabilities."
Not vague:
❌ "There are some issues with how we evaluate models."Argumentation Structure
For each main argument:
1. State the claim clearly
"First, we argue that [claim]."
2. Provide evidence
"Evidence for this comes from three sources. First, [evidence 1].
Second, [evidence 2]. Third, [evidence 3]."
3. Explain the reasoning
"These observations suggest that [interpretation]. This is significant
because [implications]."
4. Connect to main thesis
"This supports our overall position that [main claim]."Handling Counterarguments
1. State the objection fairly
"One might argue that [counterargument]."
2. Acknowledge validity (if any)
"This concern is reasonable because [acknowledgment]."
3. Provide response
"However, this objection doesn't undermine our position for three reasons.
First, [response 1]. Second, [response 2]. Third, [response 3]."
4. Conclude
"Thus, while [counterargument] raises important considerations, it doesn't
invalidate [your position]."---
Technical Report
For documenting systems, experiments, or detailed analyses
Structure
Title
Authors, Affiliations, Date
Version Number
Abstract / Executive Summary (1 page)
Table of Contents
1. Introduction (1-2 pages)
1.1 Purpose and Scope
1.2 Intended Audience
1.3 Document Organization
1.4 Related Documents
2. Background (1-2 pages)
2.1 Context
2.2 Requirements
2.3 Constraints
2.4 Assumptions
3. [Main Content Sections] (varies)
[Organized by logical structure, not necessarily IMRAD]
For system description:
3. System Overview
4. Architecture
5. Components
6. Interfaces
7. Implementation
For experiment report:
3. Methodology
4. Experimental Setup
5. Results
6. Analysis
7. Discussion
8. Conclusions and Recommendations (1-2 pages)
8.1 Summary of Findings
8.2 Recommendations
8.3 Future Work
References
Appendices
A. Detailed Specifications
B. Code Listings
C. Data Tables
D. GlossaryContent Guidelines
Executive Summary Template
[Purpose]: This technical report documents [what].
[Background]: The work was conducted to [why], addressing [problem].
[Approach]: We [method summary in 2-3 sentences].
[Key Findings/Results]:
• Finding 1
• Finding 2
• Finding 3
[Recommendations]:
• Recommendation 1
• Recommendation 2
[Conclusions]: [One sentence bottom line]Technical Content
- More detail than a paper (full equations, all parameters, complete specs)
- Can include negative results and dead ends
- Appendices for extensive details
- More figures and diagrams
- Step-by-step procedures
- Complete data tables
---
Thesis Chapter
For dissertation or thesis chapters
Structure
Chapter N: [Title]
N.1 Introduction (2-4 pages)
N.1.1 Chapter Overview
N.1.2 Connection to Thesis
N.1.3 Chapter Contributions
N.1.4 Organization
N.2 Background (2-4 pages)
N.2.1 Concepts
N.2.2 Prior Work
N.2.3 Motivation
N.3 [Core Content Section 1] (4-8 pages)
N.3.1 ...
N.3.2 ...
N.4 [Core Content Section 2] (4-8 pages)
N.4.1 ...
N.4.2 ...
N.5 [Core Content Section 3] (4-8 pages)
N.5.1 ...
N.5.2 ...
N.6 Discussion (2-4 pages)
N.6.1 Interpretation
N.6.2 Limitations
N.6.3 Implications
N.7 Summary (1-2 pages)
N.7.1 Chapter Contributions
N.7.2 Connection to Next Chapter
References (if separate per chapter)Content Guidelines
Chapter Introduction
Paragraph 1: What this chapter is about
"This chapter presents [topic]. Specifically, we [objective]."
Paragraph 2: Why it matters for the thesis
"This work addresses the second research question posed in Chapter 1:
[question]. It builds on the [previous chapter topic] presented in
Chapter [N-1] by..."
Paragraph 3: Specific contributions
"The main contributions of this chapter are: (1)..., (2)..., (3)..."
Paragraph 4: Organization
"The remainder of this chapter is organized as follows. Section N.2..."Chapter Summary
Section N.7.1 Chapter Contributions
This chapter presented [topic]. The main contributions were:
• Contribution 1 (Section N.3): [one-sentence summary]
• Contribution 2 (Section N.4): [one-sentence summary]
• Contribution 3 (Section N.5): [one-sentence summary]
These contributions demonstrate [how they address research question].
Section N.7.2 Connection to Next Chapter
Having established [current chapter achievement], the next chapter
addresses [next topic]. Specifically, Chapter [N+1] will [preview]...---
Short Paper / Extended Abstract
For workshops, poster sessions, or work-in-progress venues
Structure
Title
Authors and Affiliations
Abstract (100-150 words)
1. Introduction and Motivation (0.5-0.75 pages)
Problem, gap, contribution (very concise)
2. Approach (0.75-1 page)
Key idea and method overview
[Optional: Small diagram]
3. Preliminary Results (0.75-1 page)
[Table or figure with key results]
Brief analysis
4. Related Work (0.25-0.5 pages)
Brief positioning vs. most relevant work
5. Conclusion and Future Work (0.25 pages)
References (brief, ~10-15 papers)Content Guidelines
Extreme Conciseness
- Every sentence must count
- Focus on the key idea and main result
- Omit details available in full version
- Use figures to convey information efficiently
What to Include
- Clear problem statement
- Core novelty
- One compelling result
- Pointer to full version (if available)
What to Omit
- Extensive related work
- Detailed methodology
- Comprehensive experiments
- Lengthy discussion
Example Introduction (for 2-page paper)
Machine learning models deployed in production require robustness to
distribution shift. However, existing robustness metrics [citation]
fail to capture [specific issue].
This paper presents [method], a novel approach that addresses this gap
by [key insight]. Unlike prior work [citations] that [limitation], our
method [advantage].
We demonstrate on three datasets that [method] achieves [X]% improvement
in [metric] while maintaining [Y] computational efficiency. This suggests
[implication], opening new directions for [application].---
General Adaptation Guidelines
Adjusting for Page Limits
From 8 pages to 6 pages:
- Combine Related Work into Introduction or move to end
- Reduce number of experimental conditions
- Move details to appendix
- Tighten writing throughout
From 8 pages to 12 pages:
- Expand Related Work with more comprehensive coverage
- Add more experimental conditions or datasets
- Include additional ablation studies
- Expand discussion and implications
- Add more detailed background
Adjusting for Venue Culture
Conference vs. Journal
- Conference: More preliminary, novel ideas, faster pace
- Journal: More thorough, complete, polished
Theoretical vs. Empirical Venue
- Theoretical: More proofs, formal analysis, complexity
- Empirical: More experiments, datasets, empirical validation
Academic vs. Industrial
- Academic: Emphasize novelty and theory
- Industrial: Emphasize practical impact and deployment
---
Quick Reference: Section Purposes
| Section | Primary Purpose | Secondary Purpose |
|---|---|---|
| Abstract | Summarize entire paper | Attract readers |
| Introduction | Motivate and frame problem | State contributions |
| Related Work | Position your work | Show knowledge of field |
| Method | Explain your approach | Enable replication |
| Experiments | Describe setup | Establish rigor |
| Results | Present findings | Support claims |
| Discussion | Interpret results | Acknowledge limitations |
| Conclusion | Summarize contributions | Point to future |
---
Use these templates as starting points, but always adapt to your specific content, venue requirements, and disciplinary conventions. The best structure serves your content and helps readers understand your contribution.
Academic Writing Style Guide
Comprehensive guidance on writing with clarity, precision, and appropriate academic style.
Table of Contents
1. Core Principles 2. Sentence-Level Writing 3. Word Choice 4. Common Errors to Avoid 5. Discipline-Specific Styles 6. Revision Techniques
---
Core Principles
Clarity Above All
Academic writing should be:
- Precise: Say exactly what you mean
- Concise: Use only necessary words
- Direct: Get to the point quickly
- Accessible: Understandable to your target audience
Example Transformations:
❌ "It has been found that the utilization of deep learning methodologies
can potentially lead to improvements in performance metrics."
✅ "Deep learning improves performance by 15%."Academic Tone
Maintain professional distance without being stuffy:
Too Informal: ❌ "The results are pretty cool and show that our idea rocks."
Too Formal: ❌ "It is hereby demonstrated through empirical investigation that the aforementioned methodological approach exhibits superior characteristics."
Just Right: ✅ "Our results demonstrate that this approach outperforms existing methods."
---
Sentence-Level Writing
Active vs. Passive Voice
Prefer Active Voice
- More direct and engaging
- Clearer about who did what
- Shorter and easier to read
When to Use Active:
✅ We designed three experiments to test the hypothesis.
✅ The algorithm processes 1000 requests per second.
✅ Smith et al. (2024) proposed a novel architecture.When Passive Is Acceptable:
- When the actor is unknown or unimportant
- In methods sections for established procedures
- To maintain focus on the object
✅ Participants were randomly assigned to conditions.
✅ The samples were collected between May and August.
✅ The system was implemented in Python.Avoid Weak Passives:
❌ It was found that...
❌ It can be seen that...
❌ It is believed that...
✅ We found that...
✅ Figure 2 shows that...
✅ Researchers believe that...Sentence Structure
One Main Idea Per Sentence
❌ Our system uses a novel caching strategy that reduces latency which is
important for real-time applications where users expect immediate responses
and this is especially critical for mobile devices.
✅ Our system uses a novel caching strategy that reduces latency. This is
critical for real-time applications, particularly on mobile devices where
users expect immediate responses.Vary Sentence Length
- Short sentences (5-15 words): Emphasize key points
- Medium sentences (15-25 words): Standard explanation
- Long sentences (25-35 words): Complex relationships (use sparingly)
- Very short (1-4 words): Impact and emphasis (rare in academic writing)
Example Paragraph with Varied Length:
Transfer learning has revolutionized deep learning applications (short, 8 words).
By leveraging pre-trained models, researchers can achieve high performance with
significantly less data and computational resources than training from scratch
(medium, 21 words). This efficiency gain is particularly important in domains
like medical imaging, where labeled data is scarce and expensive to obtain, yet
model accuracy is critical for patient outcomes (long, 28 words). The impact
has been transformative (very short, 4 words).Parallel Structure
Use consistent grammatical structure in lists and comparisons:
Lists:
❌ Our contributions include:
• Designing a novel algorithm
• We provide theoretical analysis
• Experimental results demonstrate effectiveness
✅ Our contributions include:
• A novel algorithm design
• Theoretical complexity analysis
• Experimental validation on three benchmarksComparisons:
❌ Method A is fast, accurate, and uses little memory.
✅ Method A is fast, accurate, and memory-efficient.
OR
✅ Method A runs quickly, achieves high accuracy, and uses little memory.---
Word Choice
Precision
Vague → Specific
| Vague | Better | Best |
|---|---|---|
| fast | 10x faster | processes 10,000 requests/second |
| significant | statistically significant | p < 0.001, d = 0.8 |
| many | majority | 73% (n=146) |
| large | substantial | 40% increase |
| small | minor | 3% reduction |
| recently | in recent years | from 2020 to 2025 |
| improve | enhance performance | increase accuracy from 87% to 94% |
Quantify Whenever Possible:
❌ "The model performs well on most datasets."
✅ "The model achieves >90% accuracy on 7 of 9 datasets."
❌ "Training time was significantly reduced."
✅ "Training time decreased from 48 hours to 6 hours (87.5% reduction)."Conciseness
Eliminate Wordiness:
| Wordy Phrase | Concise Alternative |
|---|---|
| due to the fact that | because |
| in order to | to |
| at this point in time | now |
| a majority of | most |
| a number of | several, many |
| it is important to note that | note that (or omit) |
| with regard to | about, regarding |
| in the event that | if |
| for the purpose of | for, to |
| has the ability to | can |
| is able to | can |
| take into consideration | consider |
| make a decision | decide |
| conduct an investigation | investigate |
Avoid Nominalizations:
Nominalizations turn verbs into nouns, making writing heavy and passive.
| Nominalization | Verb Form |
|---|---|
| make an assumption | assume |
| perform an analysis | analyze |
| conduct an investigation | investigate |
| give consideration to | consider |
| make a decision | decide |
| reach a conclusion | conclude |
| provide assistance | assist, help |
| give an explanation | explain |
Examples:
❌ We conducted an analysis of the data.
✅ We analyzed the data.
❌ The committee will make a determination regarding...
✅ The committee will determine...
❌ Our findings provide evidence for the existence of...
✅ Our findings show that... exists.Appropriate Hedging
Hedge claims appropriately to maintain scientific accuracy:
Too Strong (Overconfident):
❌ Our method proves that deep learning is always superior.
❌ This definitively demonstrates the causal mechanism.
❌ All existing approaches fail to address this problem.Too Weak (Uncertain):
❌ Our results might possibly suggest that there could potentially be...
❌ It seems like this may indicate that perhaps...Appropriate Hedging:
✅ Our results suggest that deep learning performs better in this context.
✅ These findings indicate a potential causal relationship.
✅ Most existing approaches do not fully address this problem.Useful Hedging Words:
- suggest, indicate, appear, seem
- may, might, could
- likely, probably, possibly
- tend to, often, typically
- in most cases, generally
- preliminary, initial
Technical Terminology
Define on First Use:
First mention:
"We use a Transformer architecture (Vaswani et al., 2017), a neural network
model based on self-attention mechanisms."
Subsequent mentions:
"The Transformer processes sequences in parallel..."Acronyms:
✅ "We evaluate using Mean Average Precision (MAP). MAP scores range from..."
❌ "We evaluate using MAP. MAP scores range from..."
[No definition provided]Avoid Jargon When Possible:
❌ "We leverage a synergistic paradigm to operationalize the solution space."
✅ "We combine techniques X and Y to solve the problem."---
Common Errors to Avoid
1. Ambiguous Pronouns
Unclear References:
❌ "Neural networks and decision trees have different characteristics.
They require more data."
[Which one requires more data?]
✅ "Neural networks and decision trees have different characteristics.
Neural networks require more data."2. Dangling Modifiers
❌ "To improve accuracy, more data was collected."
[The data didn't try to improve accuracy]
✅ "To improve accuracy, we collected more data."3. Comma Splices
❌ "The model achieved 95% accuracy, this exceeds the baseline."
✅ "The model achieved 95% accuracy. This exceeds the baseline."
OR
✅ "The model achieved 95% accuracy, exceeding the baseline."
OR
✅ "The model achieved 95% accuracy; this exceeds the baseline."4. Subject-Verb Disagreement
❌ "The collection of algorithms are evaluated..."
✅ "The collection of algorithms is evaluated..."
OR
✅ "The algorithms are evaluated..."
❌ "Each of the methods have their own advantages."
✅ "Each of the methods has its own advantages."5. Misplaced Modifiers
❌ "We only tested the algorithm on three datasets."
[Implies you did nothing else with the algorithm]
✅ "We tested the algorithm on only three datasets."
[Correctly indicates the limitation]6. Anthropomorphism
Don't attribute human qualities to inanimate objects:
❌ "The paper argues that..."
✅ "We argue that..." or "This paper presents evidence that..."
❌ "The experiment wants to determine..."
✅ "This experiment aims to determine..."
❌ "The data tells us that..."
✅ "The data show that..."However, some anthropomorphism is acceptable:
✅ "This paper presents..."
✅ "Figure 2 shows..."
✅ "The model learns..."7. Redundancy
❌ "past history", "future plans", "end result", "final outcome"
✅ "history", "plans", "result", "outcome"
❌ "completely eliminate", "successfully achieved", "basic fundamentals"
✅ "eliminate", "achieved", "fundamentals"---
Discipline-Specific Styles
Computer Science / Engineering
Characteristics:
- Present tense for algorithms: "The algorithm traverses the tree..."
- Precise technical language
- Pseudocode and mathematical notation
- Active voice preferred
- First person common: "We propose..."
Example:
We propose a novel algorithm that exploits the sparse structure of the input
graph. The algorithm runs in O(n log n) time and requires O(n) space. We prove
that this is optimal in the worst case (Theorem 1). Experimental results on
five benchmark datasets demonstrate that our approach outperforms existing
methods by an average of 23% (Section 4).Natural Sciences
Characteristics:
- Past tense for experiments: "We measured...", "Samples were collected..."
- Present tense for established facts: "DNA consists of..."
- Passive voice acceptable in methods
- Third person traditionally preferred (changing)
- Emphasis on precision and replicability
Example:
Samples were collected from three sites over a six-month period (May–October
2024). Concentrations were measured using high-performance liquid chromatography
(HPLC). The results show a significant seasonal variation (p < 0.01). These
findings suggest that temperature plays a critical role in the observed pattern.Social Sciences
Characteristics:
- Mix of qualitative and quantitative language
- Emphasis on context and interpretation
- Acknowledgment of limitations and biases
- Past tense for research activities
- APA style citations
Example:
We conducted semi-structured interviews with 24 participants (18 women, 6 men,
ages 25–45). Interviews were transcribed verbatim and analyzed using thematic
analysis (Braun & Clarke, 2006). Three main themes emerged: (1) work-life
balance challenges, (2) organizational support structures, and (3) career
advancement barriers. These findings align with previous research (Smith, 2023)
but reveal new insights into the role of remote work policies.Humanities
Characteristics:
- More interpretive language
- Integration of quotations
- Emphasis on argumentation
- Present tense for discussing texts: "Shakespeare demonstrates..."
- Rich, varied vocabulary
Example:
Morrison's use of fragmented narrative structure serves multiple purposes.
First, it mirrors the psychological fragmentation experienced by the characters.
Second, it resists linear, Western narrative traditions that the novel critiques.
As Morrison herself notes, "Memory is a form of resistance" (Morrison, 1987,
p. 43). This resistance manifests both thematically and structurally, challenging
readers to construct meaning from seemingly disparate elements.---
Revision Techniques
The Reverse Outline
After drafting, create an outline from what you wrote:
1. Read each paragraph 2. Write a one-sentence summary 3. Check logical flow 4. Identify gaps, repetition, or disorder
Example:
Paragraph 1: Introduction to problem
Paragraph 2: Related work on approach A
Paragraph 3: Related work on approach B
Paragraph 4: Our contribution
Paragraph 5: Related work on approach C ← OUT OF PLACE!
Action: Move paragraph 5 to section 2, or remove if redundant.Read Aloud Test
Read your paper aloud (or use text-to-speech):
Signs of Problems:
- Running out of breath = sentence too long
- Stumbling over phrases = awkward construction
- Confusion about meaning = unclear writing
- Boredom = too much detail or repetition
The Clarity Pass
For each paragraph, ask:
1. Topic sentence: Does the first sentence introduce the main point? 2. Support: Do subsequent sentences develop that point? 3. Transition: Does the last sentence connect to what follows? 4. Unity: Is everything about the same topic?
Example Revision:
Before:
Deep learning has many applications. Neural networks can process images.
Convolutional neural networks are particularly effective. AlexNet was an
important breakthrough. Many researchers use deep learning now. It requires
lots of data.[Lacks focus, jumps between ideas]
After:
Convolutional neural networks (CNNs) have revolutionized computer vision.
Since AlexNet's breakthrough in 2012, CNNs have become the dominant approach
for image classification tasks. Their effectiveness stems from the ability to
learn hierarchical features directly from data. However, this data-driven
approach requires large labeled datasets, limiting applications in domains
where labeled data is scarce.[Unified topic, clear progression, smooth transitions]
The Verb Strengthening Pass
Replace weak verbs with strong, specific ones:
| Weak | Strong |
|---|---|
| is/are/was/were | depends on context |
| make | create, cause, generate, produce |
| do | perform, execute, conduct |
| have | possess, contain, exhibit |
| get | obtain, receive, acquire |
| show | demonstrate, reveal, indicate |
| use | employ, apply, utilize (when appropriate) |
| give | provide, offer, yield |
Example:
❌ "The results show that the method is effective."
✅ "The results demonstrate the method's effectiveness."
❌ "We did experiments on three datasets."
✅ "We conducted experiments on three datasets."The Specificityification Pass
Replace general terms with specific ones:
❌ "The system performs well."
✅ "The system achieves 94.2% accuracy and processes 10,000 requests/second."
❌ "Many studies have investigated this."
✅ "Over 50 studies in the past five years have investigated this."
❌ "The difference is significant."
✅ "The difference is statistically significant (p < 0.001, Cohen's d = 0.8)."The Flow Check
Examine transitions between:
- Sentences: Does each follow logically?
- Paragraphs: Is the connection clear?
- Sections: Does the organization make sense?
Transition Words by Function:
| Function | Words/Phrases |
|---|---|
| Addition | furthermore, moreover, additionally, also, in addition |
| Contrast | however, nevertheless, nonetheless, conversely, in contrast |
| Cause/Effect | therefore, thus, consequently, as a result, hence |
| Example | for instance, for example, specifically, namely |
| Sequence | first, second, finally, subsequently, then |
| Emphasis | indeed, in fact, notably, particularly, especially |
| Concession | although, while, despite, granted, admittedly |
---
Quick Reference: Style Checklist
Before Submission:
- [ ] Active voice used where appropriate
- [ ] One main idea per sentence
- [ ] Parallel structure in lists and comparisons
- [ ] Precise, quantified claims
- [ ] Concise phrasing (no unnecessary words)
- [ ] Appropriate hedging (not too strong or weak)
- [ ] All acronyms defined on first use
- [ ] No ambiguous pronoun references
- [ ] Correct subject-verb agreement
- [ ] No comma splices
- [ ] Consistent verb tense within sections
- [ ] Strong, specific verbs
- [ ] Smooth transitions between ideas
- [ ] No jargon without definition
- [ ] Appropriate disciplinary style
- [ ] Read aloud test passed
---
Remember
Good academic style is:
- Clear: Readers grasp your meaning immediately
- Concise: Every word earns its place
- Precise: Claims are specific and accurate
- Professional: Tone is appropriate for audience
- Engaging: Ideas flow smoothly and logically
Style serves substance. The goal is to communicate your research effectively, not to sound impressive. When in doubt, choose clarity over complexity.
#!/usr/bin/env python3
"""
Paper Quality Checker
A helper script to run basic quality checks on academic papers.
Checks for common issues like passive voice, hedging, construct consistency, etc.
Usage:
python check_paper.py your_paper.md
"""
import re
import sys
from collections import Counter
from pathlib import Path
class PaperChecker:
"""Checks academic papers for common quality issues."""
# Hedging words to watch for
HEDGES = [
'might', 'may', 'could', 'possibly', 'perhaps', 'maybe',
'somewhat', 'relatively', 'fairly', 'rather', 'quite',
'appears', 'seems', 'suggests', 'indicates', 'tends'
]
# Passive voice indicators
PASSIVE_INDICATORS = [
r'\bis\s+\w+ed\b',
r'\bare\s+\w+ed\b',
r'\bwas\s+\w+ed\b',
r'\bwere\s+\w+ed\b',
r'\bbeen\s+\w+ed\b',
r'\bcan be found\b'
]
# Nominalizations to avoid
NOMINALIZATIONS = {
'utilization': 'use',
'implementation': 'implement',
'analysis': 'analyze',
'investigation': 'investigate',
'examination': 'examine',
'consideration': 'consider',
'determination': 'determine'
}
# Wordy phrases
WORDY_PHRASES = {
'due to the fact that': 'because',
'in order to': 'to',
'at this point in time': 'now',
'with regard to': 'about',
'for the purpose of': 'for',
'make a decision': 'decide',
'conduct an investigation': 'investigate'
}
def __init__(self, filepath):
self.filepath = Path(filepath)
self.content = self.filepath.read_text(encoding='utf-8')
self.sentences = self._split_sentences()
self.issues = []
def _split_sentences(self):
"""Split content into sentences."""
# Simple sentence splitting
return [s.strip() for s in re.split(r'[.!?]+', self.content) if s.strip()]
def check_hedging(self):
"""Check for excessive hedging."""
hedge_count = 0
hedge_sentences = []
for sentence in self.sentences:
words = sentence.lower().split()
hedges_in_sentence = [word for word in words if word in self.HEDGES]
if hedges_in_sentence:
hedge_count += len(hedges_in_sentence)
hedge_sentences.append((sentence[:100], hedges_in_sentence))
total_words = len(self.content.split())
hedge_ratio = (hedge_count / total_words * 100) if total_words > 0 else 0
if hedge_ratio > 2.0: # More than 2% hedging words
self.issues.append({
'type': 'Excessive Hedging',
'severity': 'warning',
'message': f'Found {hedge_count} hedge words ({hedge_ratio:.1f}% of total). Consider reducing hedging.',
'examples': hedge_sentences[:3]
})
return hedge_ratio
def check_passive_voice(self):
"""Check for passive voice usage."""
passive_count = 0
passive_sentences = []
for sentence in self.sentences:
for pattern in self.PASSIVE_INDICATORS:
if re.search(pattern, sentence, re.IGNORECASE):
passive_count += 1
passive_sentences.append(sentence[:100])
break
total_sentences = len(self.sentences)
passive_ratio = (passive_count / total_sentences * 100) if total_sentences > 0 else 0
if passive_ratio > 15.0: # More than 15% passive
self.issues.append({
'type': 'Excessive Passive Voice',
'severity': 'warning',
'message': f'{passive_count} sentences use passive voice ({passive_ratio:.1f}%). Target: <10%',
'examples': passive_sentences[:3]
})
return passive_ratio
def check_sentence_length(self):
"""Check average sentence length."""
lengths = [len(s.split()) for s in self.sentences]
avg_length = sum(lengths) / len(lengths) if lengths else 0
long_sentences = [s[:100] for s in self.sentences if len(s.split()) > 30]
if avg_length > 25:
self.issues.append({
'type': 'Long Sentences',
'severity': 'info',
'message': f'Average sentence length: {avg_length:.1f} words. Target: 14-20 words.',
'examples': long_sentences[:3]
})
return avg_length
def check_nominalizations(self):
"""Check for nominalizations."""
found_nominalizations = []
for nominalization, verb in self.NOMINALIZATIONS.items():
pattern = r'\b' + nominalization + r'\b'
matches = re.finditer(pattern, self.content, re.IGNORECASE)
for match in matches:
context_start = max(0, match.start() - 40)
context_end = min(len(self.content), match.end() + 40)
context = self.content[context_start:context_end]
found_nominalizations.append((nominalization, verb, context))
if found_nominalizations:
self.issues.append({
'type': 'Nominalizations Found',
'severity': 'info',
'message': f'Found {len(found_nominalizations)} nominalizations. Consider using verb forms.',
'examples': [(f'{nom} → {verb}: {ctx}') for nom, verb, ctx in found_nominalizations[:3]]
})
return len(found_nominalizations)
def check_wordy_phrases(self):
"""Check for wordy phrases."""
found_phrases = []
for wordy, concise in self.WORDY_PHRASES.items():
pattern = r'\b' + wordy + r'\b'
matches = re.finditer(pattern, self.content, re.IGNORECASE)
for match in matches:
context_start = max(0, match.start() - 30)
context_end = min(len(self.content), match.end() + 30)
context = self.content[context_start:context_end]
found_phrases.append((wordy, concise, context))
if found_phrases:
self.issues.append({
'type': 'Wordy Phrases',
'severity': 'info',
'message': f'Found {len(found_phrases)} wordy phrases. Consider more concise alternatives.',
'examples': [(f'"{wordy}" → "{concise}": {ctx}') for wordy, concise, ctx in found_phrases[:3]]
})
return len(found_phrases)
def generate_report(self):
"""Generate a comprehensive report."""
print("=" * 70)
print(f"Paper Quality Check: {self.filepath.name}")
print("=" * 70)
print()
# Run all checks
hedge_ratio = self.check_hedging()
passive_ratio = self.check_passive_voice()
avg_sentence_length = self.check_sentence_length()
nominalization_count = self.check_nominalizations()
wordy_phrase_count = self.check_wordy_phrases()
# Summary stats
print("SUMMARY STATISTICS")
print("-" * 70)
print(f"Total words: {len(self.content.split())}")
print(f"Total sentences: {len(self.sentences)}")
print(f"Average sentence length: {avg_sentence_length:.1f} words (target: 14-20)")
print(f"Hedging ratio: {hedge_ratio:.1f}% (target: <2%)")
print(f"Passive voice: {passive_ratio:.1f}% (target: <10%)")
print(f"Nominalizations found: {nominalization_count}")
print(f"Wordy phrases found: {wordy_phrase_count}")
print()
# Issues
if self.issues:
print("ISSUES FOUND")
print("-" * 70)
for issue in self.issues:
print(f"\n[{issue['severity'].upper()}] {issue['type']}")
print(f" {issue['message']}")
if issue.get('examples'):
print(" Examples:")
for i, example in enumerate(issue['examples'], 1):
if isinstance(example, tuple):
print(f" {i}. {example[0][:80]}...")
else:
print(f" {i}. {example[:80]}...")
print()
else:
print("No major issues found! Good job!")
print()
# Scoring
score = 100
if hedge_ratio > 2.0:
score -= min(20, (hedge_ratio - 2.0) * 5)
if passive_ratio > 10.0:
score -= min(15, (passive_ratio - 10.0) * 2)
if avg_sentence_length > 20:
score -= min(10, (avg_sentence_length - 20) * 2)
score -= min(10, nominalization_count)
score -= min(5, wordy_phrase_count)
print(f"OVERALL SCORE: {max(0, score):.0f}/100")
print()
if score >= 90:
print("Excellent! Your paper is well-written and clear.")
elif score >= 75:
print("Good work! Consider addressing the issues above for improvement.")
elif score >= 60:
print("Fair. Review the issues above and revise accordingly.")
else:
print("Needs work. Please review and revise based on the issues identified.")
print("=" * 70)
def main():
if len(sys.argv) < 2:
print("Usage: python check_paper.py <paper_file>")
sys.exit(1)
filepath = sys.argv[1]
if not Path(filepath).exists():
print(f"Error: File '{filepath}' not found.")
sys.exit(1)
checker = PaperChecker(filepath)
checker.generate_report()
if __name__ == '__main__':
main()