Post Date: September 9, 2019

This site covers my choices in terms of composing documents.

It really is more dedicated to paper structuring and collaboration, rather than lower-level writing guidelines. It isn’t supposed to be a standard that is golden in any manner, and I also usually do not declare that my choices would be the right solution to do just about anything. This is certainly primarily intended for my students – particularly, to prevent being forced to repeat myself each time we take effect by having a brand new pupil (encouraged by Claire Le Goues’ post a bit right back). Nevertheless, if you find this information helpful, or desire to utilize a setup that is similar please proceed! I shall upgrade this when I think about more points (or possibly find reasons that are strong do things an additional means later on).

Setup & Directory Construction

For virtually any new paper we work with, please produce a personal GitHub repository under the following name paper to our GitHub organization- – . For instance, if I became the key composer of the paper and likely to submit the job to ICSE ‘18, I would personally name it paper-nadi-icse18 . Assume we began taking care of a paper, but still don’t a tangible place in brain. If that’s the case, utilize some phrase that is descriptive. For instance, if we had been taking care of extracting configuration constraints, the repo title will be paper-nadi-config-constr . Credits: we discovered this naming strategy inside 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 better to spot.

We shall compose all documents using LaTeX. In the event that you don’t understand LaTeX, now could be the time and energy to learn.

Whenever we are targetting a conference that is specific remember to obtain the right template when it comes to seminar. It might be this type of shame getting a desk reject, as a result of making use of the incorrect template! If we aren’t certain which seminar we are going to target, then simply utilize the standard ACM or IEEE template for the moment, but be sure to change to the right choice once we choose a seminar

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

The >main.tex file buy essays uk as required. This might be could be an example of exactly just what main.tex appears like:

  • Please try not to include any files that are generated the git repository ( ag e.g., .blg, .log, .aux etc.). And also this includes the main.pdf file.


We are going to collaborate through the repository that is git. Therefore please please please commit regularly and push the repo. You don’t have actually to attend till you’ve got completed your whole part and revised it 5 times before pressing it towards the repo. I am going to maybe not see clearly 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 very early drafts, I would personally typically mark up a pdf and deliver it for your requirements or we’d sit together and proceed through a printed part where I’ll mark up things even as we get. Either in instance, We anticipate you will upgrade things when you look at the repository a short while later. In phases, when the content is a little stable, i shall typically begin modifying things in the repository. This may often be through making commentary when you look at the text. Making it easier for me personally to go out of responses as well as for you to definitely answer them if required, will have the following macros defined (clearly, alter colors as required). If your remark was already addressed and settled, then take it off through the text.

  • there might be some areas of the paper nevertheless under construction, e.g., figures you nonetheless still need to have or even a citation you nonetheless still need to get. For those, have actually a TODO macro defined such we can quickly spot what’s left doing:
  • To be sure we could obviously see figures that want become dual checked, surround all figures with the\checkNum macro that is following. Remember to eliminate the color through the macro before publishing. Credits: once more, that is another trick I discovered from TU Darmstadt pupils.

Whenever you are the only person focusing on the repository, there are not any likelihood of disputes. Nevertheless, 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 try this via Slack or e-mail.

Before you decide to try pulling modifications to your neighborhood 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 unnecessary conflict that is merge and offers a cleaner history for all of us (i.e., no unneeded merges).

While We have perhaps not strictly implemented this myself thus far, i do believe it really is a smart idea to have each phrase in an independent line (Sebastian Proksch at TU Darmstadt, now at U. Zьrich utilized to adhere to this). This will make it better to versions that are diff resolve conflicts. We will you will need to implement this myself moving forward.

  • We don’t claim to end up being the world’s best journalist, but We have several pet peeves:
    • be sure you understand when you should make use of the vs. a vs. neither. If you learn me personally constantly incorporating or getting rid of the ’s from your own text and you also don’t know very well what the problem is, come ask me personally why. Please don’t just keep doing the thing that is same and once again; it is frustrating for both of us.
    • It is likely confusing and hard to understand if you have a sentence that’s four lines long. Break it down. The greater amount of concisely you can easily say one thing the higher. If you want more terms, utilize numerous sentences. You will need to just take 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 already are picky because it is.. don’t provide them with another explanation to shoot your paper straight down.
    • To avoid typing a list that is long and it’s difficult to remember now), Claire Le Goues’ post has good great tips on composing design. However, note just how she prefers getting the paper that is whole one file and I also don’t ? – thus, each advisor’s individual choices.
  • As a whole, anticipate to do numerous iterations on the paper. We may find yourself re-organzing things several times. show patience and present your self time that is enough of this due date of these iterations.
  • keep in mind my PhD advisor, Ric Holt, for the expressed words“big picture”. These are generally now etched during my mind. What exactly do they suggest? You constantly wish to tell your reader just what the big image is. What’s the context of this issue you’re coping with? what specifically you doing? Why should they worry about what you yourself are doing? Who can gain out of the outcomes? Just how can the total outcomes be properly used? a good paper never makes your reader wondering about some of these points. Preferably, the introduction should already respond to a lot of these picture that is“big questions without necessary overwhelming your reader with tons of low-level details or part “stories”.

    Associated with big images, I’m a fan that is big of numbers a numbered or labelled illustration of all of the actions regarding the methodology or perhaps the the different parts of a framework, as an example. These numbers can be referenced in then the text, and work out life a great deal easier for the reader. They even force one to compose in an even more structured means. Examples: Figure 1, Figure 1, or Figure 1. Notice the way they are typical Figure 1 :-)

    Preferably, you need to make your experiments such that it’s very easy to re-run them and upgrade the outcome within the paper as required.

    For figures, plots etc., the way that is best to get this done is always to have script for reproducing the graph. So we can essentially update a label, re-run the script and then re-compile our LaTeX file. In the event that you currently do your numbers in LaTeX (We really don’t simply because We never ever attempted it perhaps perhaps not because We have any such thing against it), then chances are you currently guarantee they have been always as much as date.


Leave Comment

0 Comments on This site covers my choices in terms of composing documents.

Leave a Reply

Your email address will not be published. Required fields are marked *