Home > blog > always add a fucking abstract to your project

always add a fucking abstract to your project

When you write a scientific paper, you MUST add an abstract. Then comes an introduction, new results, and conclusion. Why is an abstract necessary? Because it sums up your work. If someone doesn’t want (or has no time) to read your whole paper, (s)he should be able to have an idea about your work just by reading the abstract. The abstract must describe clearly what this paper is about. Then the reader can decide: 1) “Hmm, sounds interesting, I’ll read it.”, or 2) “Ehh, who cares?”.

So, when you write a piece of code and you decide to share it with the world, then add an abstract! I’ve met so many projects that has no abstract and then I need to do my own research to figure out what it is, what it is good for, and why I would need it.

Let’s take a terrible example. Today I read about Babel.js and decided to visit the homepage to learn more about it. What kind of information can you find on the front page?

  • Babel is a JavaScript compiler
  • Babel transforms your JavaScript

That’s all! And there is a link to ES6 features. And from this someone should understand what it is for. Well, after this I still had no idea why I would need it. So I made a Google search and found a detailed blog post at codemix.com that starts with this:

“Babel is a transpiler for JavaScript best known for its ability to turn ES6 (the next version of JavaScript) into code that runs in your browser (or on your server) today.” And then it shows an EXAMPLE. Babel converts this:

const input = [1, 2, 3];
console.log(input.map(item => item + 1)); // [2, 3, 4]

into this:

var input = [1, 2, 3];
console.log(input.map(function (item) {
  return item + 1;
})); // [2, 3, 4]

And now, 5 minutes later I know what it is for, but this info should have been on the FRONT PAGE of the project!

TL; DR: Just add a fucking abstract to your project. People will be grateful for that.

Advertisements
Categories: blog Tags: ,
  1. No comments yet.
  1. No trackbacks yet.

Leave a Reply

Please log in using one of these methods to post your comment:

WordPress.com Logo

You are commenting using your WordPress.com account. Log Out / Change )

Twitter picture

You are commenting using your Twitter account. Log Out / Change )

Facebook photo

You are commenting using your Facebook account. Log Out / Change )

Google+ photo

You are commenting using your Google+ account. Log Out / Change )

Connecting to %s

%d bloggers like this: