How to write a scientific paper worth reading
Writing a scientific paper that is worth reading is an art, not science. There is not ONE way of doing it but as many ways as there are individual skills, outlets, audiences, topics, etc.
Below I outline a top-down process of writing a scientific paper that suits *me*. Feel free to ignore it.
This page is about writing papers worth reading; keep in mind however that a paper worth reading may still not get accepted for publication...
-- Samuel Johnson
Links
- Writing a Scientific Paper (Ch. 1 in: Janet S. Dodd, The ACS Style Guide: A Manual for Authors and Editors, 2nd Ed.) On structure and style. Very useful.
Table of Contents
Process
Phase I: General
- Decide on the outlet (conference, journal, etc.)
- Decide on the scope and purpose of the paper
- Research the outlet (previous conference proceedings/issues) and decide on the canonical references to be cited and the terms to be used
- Write the Title and Abstract
- Write the Schedule
- Write the 1st-Order Outline
Phase II: Structure
- Write the 2nd-Order Outline
- Write the Throw-Away Draft
- Modify your 2nd-Order Outline using the lessons learned from writing the Throw-Away Draft
- Write the 3rd-Order Outline
Phase III: Create the paper
- Write the Sample Draft
- Submit your Sample Draft and 3rd-Order Outline for comments
- Update your 3rd-Order Outline according to the Sample Draft
Phase IV: Finalize:
- Write the Final Draft
- Get comments on the Final Draft
- Submit the paper
End Product
Each one of these end product should be created as a separate document ('file') and carry a different title. Note the formatting of each End Product.
Schedule
Create a Gantt chart listing all the phases in the Process and mark each End Product as milestones, ending with the [intended] submission deadline. Recommended minimal time spans are as follows:
- Title and Abstract should be ready at least—
- 30 days before the deadline for a paper under 10 pages (A4/Letter size) long
- 60 days before the deadline for a paper between 10-20 pages
- 90 days before the deadline for a paper longer than 20 pages
- Final Draft should be ready at least 7 days before the deadline
- If you want feedback (most recommended), allocate a 7-day task after each End Product (in parallel to your own tasks)
These rough estimates are predicated on the assumption that authors dedicate 100% of their time to writing the paper. This assumption is never true. Please adjust the estimates accordingly.
Title and Abstract
Decide on the paper's scope, contribution/novelty, audience, and write down:
- Title (2-9 words)
- Abstract (100-250 words)
- Keywords: List of 3-6 terms setting the context to your contribution (Reverse Engineering', 'Software Modelling')
- Related Terms: List 3-6 terms which describe the language you shall use for explaining your work ('Mathematical Logic', 'Object-Oriented Programming')
- Contribution: 500 words describing the scope and contribution/novelty of the paper
- Audience: Bullets describing who can benefit from your paper
- Context: A paragraph which sets your contribution in the context of the canonical work in this outlet and cite canonical references (listed in loose format)
Format: Use your favourite template.
1st-Order Outline
Create a new document with the following:
- Title & Abstract
- Divide the paper into sections and name them after the Section Topic. Do NOT commit yourself to section headings, list only topic headings outlining the general structure of the paper and the contents of each section
- Bullet-list the general contents of each section
Format: Use your favourite template.
2nd-Order Outline
Refine your 1st-Order Outline as follows:
- List tables, programs, and figures using bullets (tentative captions)
- Bullet-list outlining the details of each section and the discussion leading to each table/program/figure
Format: Use your favourite template.
3rd-Order Outline
Refine your 2nd-Order Outline as follows:
- Convert section topics into 1st-order ("1. Introduction") and 2nd-order ("1.1 Context") Section Headings aimed NOT to describe the section contents but to clarify the contribution in general terms for the busy reader
- Create and caption--
- tables
- programs
- figures/diagrams/charts
- screenshot DRAFTS
- Decide which formal definitions will appear in the paper and where each is position (in body or in appendix)
- Bullet-list exactly one bullet per each paragraph in the final paper and
list--
- all the technical terms to be defined
- all the technical terms to be used in the paper
- List references (paper title suffices)
Format: Use your favourite template.
Throw-Away Draft
Clone your 3rd-Order Outline file and refine it with text for the purpose of checking whether your 3rd-order outline is realistic.
Format: use your favourite template.
Sample Draft
Create a new document as follows:
- Create a draft of the final paper following your 3rd-Order Outline. Ensure your Sample Draft is consistent with the 3rd-Order Outline by changing both documents.
- The size of your Sample Draft should be at most 30%-40% over the size limit.
- Cite work using the [Author(s), Year] format
- Create a complete list of reference (but don't worry about their formatting)
- Enter Acknowledgements
Format: use the submission template.
Final Draft
Refine your Sample Draft with the following:
- Cut the number of words of your Sample Draft in half
- Finalize the screenshots and diagrams
- Check spelling, grammar, and detailed wording
- Nit-pick the style:
- Ensure consistent formatting of all symbols, numbers, letters, and paragraphs
- Remove extraneous spaces and empty lines
- Fix cross-references
- Format your references to fit the submission guidelines
- Make sure pages don't break tables and finalize the visual layout of your manuscript
and:
- Create manuscript submission version (PDF preferably. NEVER submit MS Word files, even if the guidelines permit it!) and ensure it fits the Final Draft
Good luck!