Premium Themes at your Fingertips!
 
Home / Blog / This site talks about my choices in terms of papers that are writing.

This site talks about my choices in terms of papers that are writing.

It really is more focused on paper structuring and collaboration, in the place of writing that is lower-level. It’s not supposed to be a golden standard in in any manner, and I also try not to declare that my choices will be the right solution to do just about anything. This is certainly mainly designed for my students – particularly, to prevent being forced to duplicate myself each time I begin working by having a brand new pupil (encouraged by Claire Le Goues’ post some time straight right back). But, if you learn this information of good use, or desire to use a comparable setup, please just do it! I shall upgrade this when I think about more points ( or possibly find strong reasons why you should do things an additional means in the future).

Setup & Directory Construction

For every single brand new paper we work with, please produce an buy essay online exclusive GitHub repository under the following name paper to our GitHub organization- – . For instance, if I happened to be the primary writer of the paper and about to submit the job to ICSE ‘18, i might name it paper-nadi-icse18 . Assume we started taking care of a paper, but nevertheless don’t a tangible place in head. If that’s the case, make use of some descriptive expression. For instance, if we were taking care of extracting configuration constraints, the repo title will be paper-nadi-config-constr . Credits: we discovered this naming strategy within my time at TU Darmstadt and discovered it quite helpful, since typically a combined team’s GitHub company could have a mixture of paper repos, rule repos, grant repos etc. Having some fixed prefix for documents made them simpler to spot.

We shall compose all documents utilizing LaTeX. In the event that you don’t now know LaTeX may be the time and energy to discover.

When we are targetting a conference that is specific remember to obtain the right template when it comes to meeting. It will be this kind of shame to obtain a desk reject, due to making use of the incorrect template! Then just use the standard ACM or IEEE template for the time being, but make sure to switch to the right one when we decide on a conference if we are not sure which conference we will target

Rename the primary LaTeX file as main.tex and ensure that it stays within the directory that is main. Make an independent tex apply for each area into the paper, and organize the directory as follows (this instance assumes our company is utilizing the ACM template):

The >main.tex file as needed. This will be could be a good example of exactly just what main.tex appears like:

  • Please don’t include any generated files in the git repository ( ag e.g., .blg, .log, .aux etc.). And also this includes the main.pdf file.

Collaboration

We’re going to collaborate through the repository that is git. Therefore please please please commit regularly and push the repo. You don’t to hold back it 5 times before pushing it to the repo till you have finished the whole section and revised. I shall maybe perhaps not read it anyways me it is ready so commit often so we have good history in case something goes wrong and so we don’t loose all your writing in case your computer crashes until you tell.

For very early drafts, i might typically mark up a pdf and deliver it to you personally or we might sit together and proceed through a printed part where I’ll mark up things once we get. In a choice of situation, I anticipate you will update things into the repository a short while later. In stages, after the content is a little stable, I will typically begin editing things in the repository. This can often be through making remarks when you look at the text. Making it easier in my situation to go out of feedback as well as for you to definitely react to them if required, will have the following macros defined (clearly, alter colors as required). In cases where a remark had been addressed and settled, then take it off from the text.

  • There could be some elements of the paper nevertheless under construction, e.g., figures you nevertheless still need getting or a citation you nevertheless still need to locate. For those, a TODO macro defined such that individuals can quickly spot what’s left to accomplish:
  • To be sure we could demonstrably see figures that require become dual checked, surround all figures with the next \checkNum macro. Be sure to get rid of the color through the macro before publishing. Credits: once again, this can be another trick we discovered from TU Darmstadt pupils.

When you’re alone focusing on the repository, there aren’t any odds of disputes. But, that we are not both editing the same sections (that’s why I like each section to go in a separate file) if we are both editing the paper, we should coordinate such. We are able to repeat this via Slack or email.

Before you decide to try pulling modifications into the regional repository, make yes to commit your present changes first then do git pull –rebase . Perform some same before pressing modifications. This decreases the probability of us getting unneeded conflict that is merge and offers a cleaner history for people (for example., no unnecessary merges).

Myself so far, I think it is a good idea to have each sentence in a separate line (Sebastian Proksch at TU Darmstadt, now at U. Zьrich used to follow this) while I have not strictly implemented this. This makes it more straightforward to diff variations and resolve conflicts. We will you will need to implement this myself in the years ahead.

  • We don’t claim to be the world’s writer that is best, but We have several pet peeves:
    • make certain you understand when you should utilize the vs. a vs. neither. If you discover me personally constantly incorporating or getting rid of the ’s from your own text and you also don’t determine what the problem is, come ask me personally why. Please don’t just keep doing the same task over and once more; it is frustrating for both of us.
    • For those who have a phrase that is four lines very long, chances are confusing and hard to comprehend. Break it down. The greater concisely it is possible to say one thing the better. If you want more words, utilize numerous sentences. You’ll want to use the audience through the movement of one’s arguments. Don’t loose visitors by forcing them to return and read each sentence or paragraph twice. Make their life easier. Reviewers seem to be particular them another reason to shoot your paper down as it is.. don’t give.
    • To prevent typing a lengthy list ( and it’s hard to remember now), Claire Le Goues’ post has good recommendations on composing style. Nevertheless, note just how she prefers having the paper that is whole one file and I also don’t ? – thus, each advisor’s preferences that are personal.
  • As a whole, expect you’ll do iterations that are multiple the paper. We possibly may find yourself re-organzing things several times. Show patience and present your self time that is enough for the due date of these iterations.
  • keep in mind my PhD advisor, Ric Holt, for the expressed words“big picture”. These are typically now engraved during my mind. Just what exactly do they suggest? You always like to inform your reader what the picture that is big. What’s the context of this issue you will be working with? what specifically you doing? Why should they value what you are really doing? That will gain out from the results? How do the total outcomes be properly used? a good paper never ever renders your reader wondering about some of these points. Preferably, the introduction should currently respond to a lot of these “big picture” concerns without necessary overwhelming your reader with a lot of low-level details or part “stories”.

    Associated with big images, I’m a fan that is big of numbers that offer a numbered or labelled example actions for the methodology or perhaps the aspects of a framework, for instance. These figures can be referenced in then the text, while making life a great deal easier for your reader. They even force you to compose in a far more way that is structured. Examples: Figure 1, Figure 1, or Figure 1. Notice the way they Figure 1 :-)

    Preferably, you need to create your experiments such that it’s simple to re-run them and upgrade the outcome into the paper as required.

    For numbers, plots etc., the way that is best to get this done is always to have script for reproducing the graph. So we can essentially upgrade a label, re-run the script and then re-compile our LaTeX file. Then you already guarantee they are always up to date if you already do your figures in LaTeX (I personally don’t just because I never tried it not because I have anything against it.

    Leave a comment