aaron • September 10, 2019 • Comments Off on This site covers my choices in terms of papers that are writing.
It really is more dedicated to paper structuring and collaboration, in the place of lower-level writing recommendations. It is really not supposed to be a standard that is golden in whatever way, and I also usually do not declare that my choices will be the right solution to do just about anything. This really is mainly intended for my students – particularly, to prevent being forced to duplicate myself each and every time we take effect with a brand new pupil (motivated by Claire Le Goues’ post a little while straight back). Nonetheless, if you learn this information helpful, or wish to utilize a comparable setup, please proceed! I’ll upgrade this when I think about more points ( or even find strong reasons why you should do things in another method later on).
For each and every brand brand new paper we work with, please produce a personal GitHub repository under the following name paper to our GitHub organization- – . For instance, I would name it paper-nadi-icse18 if I was the main author of the paper and planning to submit the work to ICSE ‘18 . Suppose we began taking care of a paper, yet still don’t have actually a tangible location in head. If that’s the case, make use of some phrase that is descriptive. for instance, if we had been taking care of extracting configuration constraints, the repo title could be paper-nadi-config-constr . Credits: we discovered this naming strategy during my time at TU Darmstadt and discovered it quite of good use, since typically a combined team’s GitHub company might have a mixture of paper repos, rule repos, grant repos etc. Having some fixed prefix for documents made them more straightforward to spot.
We will write all documents making use of LaTeX. In the event that you don’t understand LaTeX, now may be the time and energy to learn.
Whenever we are targetting a conference that is specific be sure to have the right template for the seminar. It might be this type of shame to obtain a desk reject, as a result of with the template that is wrong! When we aren’t certain which seminar we shall target, then simply utilize the standard ACM or IEEE template for the moment, but remember to change to the correct one once we determine a meeting
Rename the primary LaTeX file as main.tex and ensure that is stays into the primary directory. Make an independent tex apply for each part when you look at the paper, and organize the directory as follows (this instance assumes we have been utilising the ACM template):
The >main.tex file as required. This might be will be a good example of just just what main.tex appears like:
We shall collaborate through the repository that is git. Therefore please please please commit regularly and push the repo. You don’t to attend it 5 times before pushing it to the repo till you have finished the whole section and revised. I am going to not read it anyways unless you let me know it really is ready so commit often therefore we have actually good history just in case one thing goes incorrect and thus we don’t loose your entire writing should your computer crashes.
For very early drafts, i might typically mark up a pdf and deliver it to you personally or we might stay together and proceed through a printed part where I’ll mark up things even as we get. Either in full instance, I anticipate that you’ll upgrade things into the repository a short while later. In phases, when the content is really a bit stable, i am going to typically start things that are editing the repository. This may frequently be through making reviews into the text. Making it easier for me personally to go out of responses as well as you to definitely react to them if required, also have the following macros defined (clearly, alter colors as required). Then remove it from the text if a comment has already been addressed and resolved.
If you’re the only one focusing on the repository, there aren’t any likelihood of disputes. Nonetheless, whenever we are both editing the paper, we ought to coordinate in a way that our company is maybe not both editing the exact same parts (that’s why i love each part to get in a different file). We could repeat this via Slack or e-mail.
Before you decide to try pulling modifications to your repository that is local yes to commit your present changes first after which do git pull –rebase . Perform some same before pressing changes. This decreases the likelihood of us getting unneeded merge conflict communications and offers a cleaner history for people (for example., no unneeded 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 will make it more straightforward to versions that are diff resolve conflicts. We shall make an effort to implement this myself in the years ahead.
I usually keep in mind my PhD consultant, Ric Holt, for the expressed words“big picture”. These are generally now etched in my own mind. What exactly do they suggest? You constantly wish to inform the reader just what the big photo is. What’s the context for the issue you might be working with? What precisely you doing? Why should they worry about what you are really doing? Who’ll gain out from the outcomes? How do the outcomes be utilized? a good paper never ever makes your reader wondering about some of these points. Preferably, the introduction should currently respond to many of these picture that is“big concerns without necessary overwhelming your reader with a lot of low-level details or side “stories”.
Pertaining to big photos, I’m a fan that is big of numbers that offer a numbered or labelled example actions associated with methodology or the the different parts of a framework, as an example. These figures can then be referenced in the text, while making life a great deal easier for your reader. In addition they force you to definitely compose in a far more structured means. Examples: Figure 1, Figure 1, or Figure 1. Notice the way they are typical Figure 1 🙂
Preferably, you wish to make your experiments such that it’s very easy to re-run them and upgrade the outcomes within the paper as required.
For numbers, plots etc., the way that is best because of this would be to have script for reproducing the graph. Therefore we can essentially upgrade a label, re-run the script and re-compile our LaTeX then file. In the event that you currently do your figures in LaTeX (We physically don’t simply because We never ever attempted it maybe maybe not because We have such a thing against it), then chances are you currently guarantee these are generally always as much as date.