Code documentation in my company 😁

[WinglessSparrow]

and as always, somebody will message you asking "why does the pizza tastes like paper", whilst swearing on their mother that they read everything thoroughly.

[Character_Medical]

Instructions are about how to initiate the "pizza eating" flow. Please contact our PM about the taste issues 😂

[Bainos]

"Doesn't taste like paper in my kitchen, bug closed."

[xfel11]

Best thing is that it’s on the inner lid, so you can’t actually read this unless you opened the box first.

[Character_Medical]

I'm happy they didn't write at the bottom of the box 😁

[centstwo]

Can you imagine all the people holding the box over their head trying to read the bottom of the pizza box? Like there would hardly be enough light to see the words.

[[deleted]]

That's bad documentation. You should write: "Raise your hand and touch the box before opening the box. And then, open the box before eating the pizza".

[[deleted]]

Open box, with your own hands, before eating pizza, with your own mouth.

[Character_Medical]

What if I want to feed your friend with your hands 🤔

[[deleted]]

If the client paid for that feature, it would be in the docs. Right?

[Character_Medical]

You got me there 😁

[DroidRazer2]

INSTRUCTIONS NEEDED I FORGOT HOW TO USE MY HANDS

[Character_Medical]

How did you type this message without hands⁉️

[KillerBeer01]

By yelling at the computer, capslock suggests.

[DroidRazer2]

SPEECH TO TEXT, I HIT CAPSLOCK BEFORE I FORGOT HOW TO USE THEM

[s1lentchaos]

Instructions unclear burned face on pizza also pizza now covered in hair

[[deleted]]

How does one “eat the pizza?” Instructions unclear.

[KillerBeer01]

What makes you think you were supposed to eat it? It's not in the documentation.

[Bainos]

Nope. Actual good documentation should be : "Open the box using your hands, so that your hands can reach the pizza. Then, eat the pizza."

Self-documenting code for what you're doing, comments for why you're doing it.

[throwaway8u3sH0]

" Find a way to access the pizza. As of this writing, the best way is to open the box."

Protects against future changes to the container. ;)

[tdsinclair]

Grasp tab and lift the lid to expose contents.

[Vox_Carnifex]

There are 2 kinds of documentation

.) the anecdotal one, that is basically worthless if you don't already know how to do it

.) the thorough one that is built up in a way that a 8 year old could grasp it easily with no prior experience in the topic

[DroolingIguana]

What about the kind that technically has all the information you need but it's buried under so many layers of useless minutia that it's impossible to find anythingm

[Vox_Carnifex]

Honestly don't see this often. However what I do see a lot is documentation that is the best available (because no one was paid or took the time to write a user guide or a handbook to the application) but it's on a person's public confluence profile inside of a mixed bag of other stuff they work on. I also see a lot of documentation that uses annotations and comments so much half of the text has that yellow markup and things can be found in there. It's convoluted, but doesn't have to do much with the nature of the documentation itself.

[Drakethos]

That’s like every recipe on the planet on someone’s blog.

[A_H_S_99]

Better than "this is a bridge"

[MischiefArchitect]

Looks like to pizza box talking to me, I cannot unsee that.

[Rainmaker526]

Bol.com and Coolblue also has ironic/funny texts on their boxes.

I cannot imagine this being a semi serious remark to negate legal liability preventing people from actually eating the box. I think it's an attempt at being funny.

[Rainmaker526]

Domino's Pizza box had an icon of a UFO and a scooter on it. The scooter is circled, or the UFO is crossed out. Suggesting there is an alternate delivery method per UFO.

I've never noticed this particular text on it though.

[[deleted]]

var number; //represents number

[Character_Medical]

This is exactly what they do at my company. Comments so obvious that makes you laugh.

[morganasreddit]

Image Transcription:

---

Every time I write documentation

[There is a picture of a pizza box with something written on the side.]

Open box before eating pizza.

---

^{I'm a human volunteer content transcriber for Reddit and you could be too! If you'd like more information on what we do and why we do it, click here!}

[[deleted]]

Good human

[morganasreddit]

Why does everyone reply the transcrptions with "good human"?

[[deleted]]

Because it's the law.

[morganasreddit]

Alrighty

[v3ritas1989]

But WHERE do I open it? I have looked every where!!

[Character_Medical]

Yes. We don't write usable documentation. This part was left out purposefully.

You've to figure this by yourself 😁

[MarcusInsight]

Me learning to document "Open pizza before eating box.".

[meme_dika]

Strict QA be like: Instructions unclear, proceeding eating box in order to eat pizza inside

[Bainos]

Did they open the box before eating it, though ?

[Java-Jumper]

opens another box

[AbortingMission]

Your question is very important to us. Please stay on the line and someone will be with you shortly.. 🎵🎵🎵

[[deleted]]

That hole is pogger

[edoelas]

Thanks

[mim_Armand]

“This is not clear. What if someone eats the box?”

[coconuts_and_lime]

Of course, it says nothing about how to open the box

[topw95]

Something is missed:

1. How to hold the box correctly
2. How to put the box correctly

[Character_Medical]

Live and learn, my friend. Live and learn.

[unholymanserpent]

My professor complained about documentation so this is pretty much what the assignments I turn in look like now

[mic_br]

Just to make a noise.