It is dangerous to give a ‘formula’ or algorithm for technical communication. Rigid approaches will probably result in bad writing. Some venues expect extremely standardized writing, schematics, etc. (IEEE ISSCC for example)
The best advice: Read many many examples (both good and bad).
Good sources:
Strunk Jr, W., & White, E. B. (2007). The Elements of Style Illustrated. Penguin.
Pinker, S. (2015). The sense of style: The thinking person’s guide to writing in the 21st century. Penguin Books.
Here are some general guidelines to consider:
- Almost always, USE FEWER WORDS. (Strunk & White)
- Focus on clarity and directness.
- Usually active voice is better. (maybe not always)
- Avoid needing to use I or We. Even if you are the sole author, most physics and engineering venues prefer the use of We.
- Plan or outline your paragraphs before you write them.
- Be mindful of symbols. For example dashes, minuses, and hyphens.
- If sections of material seem dense, move them to an appendix.
Here are some questions/writing prompts to think about that may help get started:
- What is the the critical issue or problem you are addressing?
- How are you solving or making essential steps to solving a critical problem?
- Are you or do you aim to introduce any new techniques or methodologies with significant impact?
Many manuscripts have formats like:
- Title
- List of authors
- Abstract
- Keywords
- Introduction
- Background
- Methodology/approach/design
- Results/measurements
- Discussion/interpretation/comparison to the state-of-the-art
- Conclusion
- References/bibliography
- Appendices
- Supplemental material
Abstract: In my opinion, the abstract of an article categorizes the work. In reality, most of the final abstracts that I have authored happen as the last step. However, some venues require an abstract (or at least an abstract draft) near the beginning of the submission process. The following questions will go on to form a draft of an abstract:
- What has been done by others/what do you plan to do?
- What are the important details?
- Why is it novel or what is the issue at hand?
- What is presented/included in this work?
- What is the big picture of the contribution? Where does it fit in with the community?
Introduction: In my opinion, the introduction of an article orients the reader and communicates the value of the manuscript. Sometimes, value is communicated with (tasteful) salesmanship, however, this salesmanship can quickly lead an audience to disbelief. It must be direct, honest, and limited to reasonable boundaries. The following questions will go on to form a draft of an abstract:
- What has been done? (Big picture by others)
- What is the big motivation?
- What are the important details, issues or problems?
- Why is it novel?
- Where does it fit in with the community?
- Why is this work valuable?
- What is presented?
- What is the big picture of the contribution?