Skip to content

Instantly share code, notes, and snippets.

@erickpatrick

erickpatrick/summary-creation-publication.md

Created January 18, 2019 16:28
Show Gist options
  • Save erickpatrick/42123cff498a4bec7802769fde8102bf to your computer and use it in GitHub Desktop.
Save erickpatrick/42123cff498a4bec7802769fde8102bf to your computer and use it in GitHub Desktop.
Download ZIP
Summary to create publications (scientific papers or not)
Raw
summary-creation-publication.md

-- precise word use, past tense, active voice, brevity.

Title of post

  • categories

Abstract

225 chars

Introduction

  • not fully in details but more detailed than Abstract
    • background
    • motivation
    • importance
  • outline (description of the following sections)

Related works

  • shows things related to the topic
    • criticize them showing their bad and good parts
    • show how differently is your thinking

System model

  • declare all hypothesis and assumptions of the environment where the problem resides
    • provide support for assumptions
    • try adding a figure

Problem statement

  • describe as exact as possible the problem

Solution

  • start with overview of solution
  • good explanation of rationale, concepts and mechanisms
    • explain required concepts before into detailed description
  • detailed description of solution and functionality
    • just description of solution itself
    • no debates
    • no comparison
  • explain each part of the functionality separately
    • make smaller, self-contained "components" out of the full functionality
  • use imagery, preferable close to the one shown on System model

Analysis

  • Qualitative
    • show some properties/desired behavior of the solution
  • Quantitative
    • show performance of the solution based on some metric
      • explain why a specific metric was chosen

Simulation and Experimentation

  • depends on budget/time
    • do only if really needed
  • each figure/graph should be well explained
    • at least one paragraph each
    • describe what is seen and what should be noticed
    • give reason on the result
      • are they what they are supposed to be?
  • compare performance of solution to other solutions
    • test scenarios must be fair for all tests

Conclusions

  • elaborate on the impact of the approach
  • state limitations or disadvantages of approach
    • allows directions for further research

Bibliography

  • mention bibliography in the introduction or related work

References

  • ...
@erickpatrick
Copy link
Author

https://templates.netlify.com/

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment