scientific-manuscript-writing

Scientific Manuscript Writing

Overview

Scientific manuscript writing is the discipline of communicating research findings with precision, clarity, and reproducibility. This knowhow covers the complete lifecycle of manuscript preparation: from planning and structuring a paper using IMRAD format, through applying correct citation styles and designing effective figures, to ensuring compliance with study-specific reporting guidelines. It applies across biomedical, social science, engineering, and computational fields.

This entry consolidates writing principles, manuscript structure, citation systems, figure/table design, and reporting standards into a unified reference for producing publication-ready scientific documents.

Key Concepts

Writing Principles: Clarity, Conciseness, Accuracy

The three pillars of scientific writing govern all manuscript text:

• Clarity: Use precise, unambiguous language. Define technical terms at first use. Maintain logical flow within and between paragraphs. Use active voice when it improves understanding; passive voice is acceptable in Methods when the action matters more than the actor.
• Conciseness: Express ideas in the fewest words necessary. Eliminate redundant phrases ("due to the fact that" becomes "because"; "in order to" becomes "to"). Favor shorter sentences (15-20 words average). Use strong verbs instead of noun-verb combinations ("analyze" not "perform an analysis").
• Accuracy: Report exact values with appropriate precision matched to measurement capability. Use consistent terminology throughout. Distinguish observations from interpretations. Verify that numbers in text match tables and figures.

Additional principles include objectivity (present results without bias, acknowledge conflicting evidence), consistency (same term for same concept, uniform notation), and logical organization (clear "red thread" connecting sections). See references/writing_principles_style.md for detailed guidance with examples.

IMRAD Structure

IMRAD (Introduction, Methods, Results, And Discussion) is the standard organizational structure for original research articles, adopted across most scientific disciplines since the 1970s. It mirrors the scientific method:

| Section | Question Answered | Primary Tense | Typical Length | |---------|-------------------|---------------|----------------| | Title | What is this about? | N/A | 10-15 words | | Abstract | Complete summary | Mixed | 100-250 words | | Introduction | Why did you study this? | Present/past | 4-5 paragraphs | | Methods | How did you do it? | Past | 2-4 pages | | Results | What did you find? | Past | 2-4 pages | | Discussion | What does it mean? | Past/present | 3-5 pages | | Conclusion | Take-home message | Present | 1-2 paragraphs |

The Introduction follows a funnel structure: broad context, narrowing literature review, gap identification, and study objectives. Methods must provide sufficient detail for replication. Results present findings objectively without interpretation. Discussion interprets findings, compares with prior work, acknowledges limitations, and proposes future directions.

Venue variations: Nature/Science use modified IMRAD with methods in supplement. ML conferences (NeurIPS/ICML) use Introduction-Method-Experiments-Conclusion with numbered contributions and ablation studies. See references/manuscript_structure.md for section-by-section guidance.

Citation Systems

Five major citation styles serve different disciplines:

| Style | Format | Primary Disciplines | |-------|--------|---------------------| | AMA | Superscript numbers | Medicine, health sciences | | Vancouver | Numbers in brackets [1] | Biomedical sciences | | APA | Author-date (Smith, 2023) | Psychology, social sciences | | Chicago | Notes-bibliography or author-date | Humanities, some sciences | | IEEE | Numbers in brackets [1] | Engineering, computer science |

Best practices across all styles: Cite primary sources when possible. Include recent literature (within 5-10 years for active fields, 2-3 years for ML). Balance citation distribution across Introduction and Discussion. Verify all citations against original sources. Keep self-citations below 20%. Always check the target journal's author guidelines for the required style.

See references/citation_guide.md for complete format specifications, journal-specific requirements, and DOI formatting rules.

Figure and Table Design Principles

Figures and tables are the backbone of a scientific paper; many readers examine them before reading the text.

Decision rule: Can the information be conveyed in 1-2 sentences? If yes, use text only. If no and precise values are needed, use a table. If no and patterns/trends matter most, use a figure.

Core design principles:

1. Self-explanatory: Each display item must stand alone with a complete caption defining all abbreviations, units, sample sizes, and statistical annotations
2. No redundancy: Text highlights key findings from displays; it does not repeat all data
3. Consistency: Uniform formatting, color schemes, and terminology across all display items
4. Optimal quantity: Approximately one display item per 1,000 words of manuscript
5. Accessibility: Color-blind safe palettes (blue-orange, viridis); designs that work in grayscale

Error bar rule: Always state which measure is shown (SD for data spread, SEM for measurement precision, 95% CI for significance assessment). 95% CI is generally preferred because non-overlapping CIs indicate significant differences.

See references/figures_tables_guide.md for figure type selection, table formatting, statistical presentation, and journal-specific requirements.

Decision Framework

What type of scientific document are you writing?
|
+-- Original research article
|   |
|   +-- Clinical trial --> IMRAD + CONSORT reporting guideline
|   +-- Observational study --> IMRAD + STROBE reporting guideline
|   +-- Animal study --> IMRAD + ARRIVE reporting guideline
|   +-- Diagnostic accuracy --> IMRAD + STARD reporting guideline
|   +-- Prediction model --> IMRAD + TRIPOD reporting guideline
|   +-- ML/CS research --> Intro-Method-Experiments-Conclusion
|
+-- Review / synthesis
|   +-- Systematic review --> PRISMA reporting guideline
|   +-- Narrative review --> Thematic structure
|   +-- Meta-analysis --> PRISMA + forest plots
|
+-- Case report --> CARE guideline
|
+-- Study protocol --> SPIRIT guideline
|
+-- Quality improvement --> SQUIRE guideline
|
+-- Economic evaluation --> CHEERS guideline
|
+-- Professional report / white paper --> scientific_report.sty (see assets/)

| Venue Type | Structure | Citation Style | Key Adaptation | |-----------|-----------|---------------|----------------| | Nature/Science | Modified IMRAD, methods in supplement | Numbered superscript | Accessible language, broad significance, story-driven | | Medical journals (NEJM, JAMA) | Strict IMRAD | Vancouver/AMA | Structured abstracts, clinical focus, CONSORT/STROBE | | Field-specific journals | Standard IMRAD | Varies by field | Full technical detail, field terminology | | ML conferences (NeurIPS, ICML) | Intro-Method-Experiments-Conclusion | Numbered or author-year | Numbered contributions, ablations, pseudocode | | Professional reports | Chapter-based | N/A | Use scientific_report.sty for formatting |

Best Practices

1. Write the abstract last: After completing all sections, synthesize the key message into 100-250 words. Include quantitative results with statistical measures.
2. Plan figures before writing: Design figures and tables as the data story backbone. Write Methods first, then Results describing the displays, then Discussion interpreting them, then Introduction framing the question.
3. One idea per paragraph: Start with a topic sentence, develop with supporting evidence, end with a transition to the next