Oh Absolutely. I Have Written Every Single Report And Paper That Non-programmers ( Users, Pruduct Owner,

Oh absolutely. I have written every single report and paper that non-programmers ( Users, pruduct owner, whatever ) in LaTeX.

It is Word. But you can do ANYTHING you want, work in the same updated file if you use overleaf ( Like google docs.... But you know... good... ).

And if you just want to write a basic report with a few diagrams. LaTeX just makes it nice and easy and looks good, dry and professional.

But markdown... Oh markdown is for documentation. And it is perfect.

It is super super easy to use. The "Cost" of this, is that you only have few features...

And that is KEY. Combined with you being able to put pictures in what is otherwise basically cleartext, means that you MUST be able to clearly explain whatever it is you are documenting with nearly no fancy text, colors, weird structureing with the words or whatever.

No. You MUST do it in text... Or use a diagram.

It forces you to use DIAGRAMS in your documentation. Glorious easy-to-read better than a thousand words diagrams.

It removes the horrible middle-ground and lets you focus on making documentation super super fast, with text and diagrams.

Fun fact. Markdown... is a markup language

If you do not know what markup is... you should look it up. It is basically HTML that works both encoded and as clear text. Meaning it is the perfect note taking "language". In reality it is "just" "a convention for how to write super nice-looking notes that have been tested by millions of people to be the very best it can be. No big deal. Oh also it is free, you do not even need a special program to look at it. Your browser can do it perfectly.

(Nearly) Never use auto in C++!!!

So I used to be amongst the people who thought "Yeah ok, auto hides the type. But if the type is not really important to understand the code, and was really long and confusing then it is worth it"

Like this: std::vector<std::pair<std::string, Employee>> MyFunction(); To turn it into: auto MyFunction();

And I was wrong. Do NOT use auto to hide that monstrosity. You FIX it. auto hides that awful thing and dumps the problem on the next poor fucker who will use it. ( People writing and using metaprogramming libraries are especially prone to doing this, since their typenames can fill entire screens ).

YOU just looked at YOUR code. Found it confusing... And decided... to HIDE it??? What it is the next person who did NOT write this code going to do when they read this going to do???

No. I beg of you. Use typedef.

You can create aliases of anything and make your code easy to read. And this only "hides" the code as much as auto and you can get the types the alias points to by musing over it. So it is auto... but way better. Because it is a UNIQUE name. Which can DESCRIBE things.

Like, with the horror in the previous example. Let us have a typedef in the .hpp file where "MyFunction" is declared. Now it reads MUCH better:

std::vector<std::pair< Employee_ID, Employee>> MyFunction();

I actually understand what the pair is now! Key value pairs! And screw it. Let us typedef the pair too now that we understand it!

std::vector<Employee_KeyValuePair> MyFunction();

And fuck it. Once more! Typedef the vector too!

Employee_Roster MyFunction();

I will bet most of you reading this only realized what the hell that moster was when you got near the end. BECAUSE THE FIRST THING IS FREAKING UNREADABLE! Fix it. Make your code readable. If you feel the urge to use an auto to hide a typename, it is time to typedef that motherfucker!

That is a very good point. I absolutely agree!

(Nearly) Never use auto in C++!!!

So I used to be amongst the people who thought "Yeah ok, auto hides the type. But if the type is not really important to understand the code, and was really long and confusing then it is worth it"

Like this: std::vector<std::pair<std::string, Employee>> MyFunction(); To turn it into: auto MyFunction();

And I was wrong. Do NOT use auto to hide that monstrosity. You FIX it. auto hides that awful thing and dumps the problem on the next poor fucker who will use it. ( People writing and using metaprogramming libraries are especially prone to doing this, since their typenames can fill entire screens ).

YOU just looked at YOUR code. Found it confusing... And decided... to HIDE it??? What it is the next person who did NOT write this code going to do when they read this going to do???

No. I beg of you. Use typedef.

You can create aliases of anything and make your code easy to read. And this only "hides" the code as much as auto and you can get the types the alias points to by musing over it. So it is auto... but way better. Because it is a UNIQUE name. Which can DESCRIBE things.

Like, with the horror in the previous example. Let us have a typedef in the .hpp file where "MyFunction" is declared. Now it reads MUCH better:

std::vector<std::pair< Employee_ID, Employee>> MyFunction();

I actually understand what the pair is now! Key value pairs! And screw it. Let us typedef the pair too now that we understand it!

std::vector<Employee_KeyValuePair> MyFunction();

And fuck it. Once more! Typedef the vector too!

Employee_Roster MyFunction();

I will bet most of you reading this only realized what the hell that moster was when you got near the end. BECAUSE THE FIRST THING IS FREAKING UNREADABLE! Fix it. Make your code readable. If you feel the urge to use an auto to hide a typename, it is time to typedef that motherfucker!

Fun fact. Markdown... is a markup language

If you do not know what markup is... you should look it up. It is basically HTML that works both encoded and as clear text. Meaning it is the perfect note taking "language". In reality it is "just" a convention for how to write super nice-looking notes that have been tested by millions of people to be the very best it can be.

No big deal.

Oh also it is free, you do not even need a special program to look at it. Your browser can do it perfectly.

I... I feel like I am getting diabetes by reading this post!

It is SO sweet and positive and wonderful and just... "chef's kiss"

✧･ﾟ: Customize your highlight color! :･ﾟ✧

I recently came across a blog where when I went to highlight some text I noticed it was a unique color!!! (」°ロ°)」

AND IT'S SO SIMPLE TO DO

all you do is go to your css file and add this:

::selection { background: <hexcolor> }

Enjoy!! ♡⸜(˶˃ ᵕ ˂˶)⸝♡

I am average american man I work fifteen hours in hamburger mine to buy one rock and roll disk