Tentative and Suggested Outline of a Technical Manuscript
Order in manuscript |
Order in writing |
Section |
1 |
6th |
Abstract: |
1.1 |
|
What is the problem to be solved? |
1.2 |
|
How is the problem solved? |
1.3 |
|
How good the solution is (according to the provided evaluation)? |
2 |
7th |
Introduction: |
2.1 |
|
Why is the problem to be solved important? |
2.2 |
1st |
What has been done and why those solutions are not good enough? (critical) |
2.3 |
|
What is the proposed solution? |
2.4 |
|
How the proposed solution changes the fields or understanding of the problem theme? |
2.5 |
|
In summary, what is the contribution of the paper? |
2.6 |
|
Optional but almost always present: What is the organization of the paper? |
3 |
2nd |
Methods: |
3.1 |
|
Introduction of critical concepts/variables |
3.2 |
|
How the solution works (intuition + algorithmic description)? |
4 |
3rd |
Results: |
4.1 |
|
What are the metrics used to quantify/properties performance? |
4.2 |
|
How was the solution evaluated? |
4.3 |
|
What are the results (quantitative graphs or tables)? |
4.4 |
|
Why the results make sense (for each result)? What does explain the results? |
5 |
4th |
Discussion: |
5.1 |
|
What are the assumptions used in the evaluation? What is not included in the analysis? |
5.2 |
|
What should be considered in the next step or future research? |
6 |
5th |
Conclusions: |
6.1 |
|
What problem was solved? |
6.2 |
|
What was proposed? |
6.3 |
|
How was the proposed solution proved that really solves the problem? |
6.4 |
|
What we learnt from the study (quantitative knowledge is preferred)? (Take away message) |