Skip to content
DevMeme
2919 of 7590
Documentation Post #3225 · source on Telegram

The Ascended State of Code Documentation

Description

A two-panel meme that humorously escalates the concept of code documentation. The format is taken from the video game 'Gunpoint,' showing achievement-like notifications. The first panel says, 'Adding comments to your code so others can understand it,' and labels this achievement as 'Gentleman,' showing a pixelated character in a trench coat. The second panel presents a far more extreme idea: 'Voice record yourself speaking out each line of code explaining what it means,' and labels this as 'Perfect Gentleman,' with a glowing, golden version of the same character. The joke satirizes the debate around code documentation by presenting a ridiculously impractical method as the pinnacle of consideration. For experienced developers, it's a funny take on the spectrum of documentation efforts, from helpful to absurdly over-engineered, and the eternal quest for perfectly clear, maintainable code

Comments

37
Anonymous ★ Top Pick I submitted a PR with audio commentary, but it got rejected. The reviewer said my explanation of the regex was just 15 seconds of uninterrupted weeping
  1. Anonymous ★ Top Pick

    I submitted a PR with audio commentary, but it got rejected. The reviewer said my explanation of the regex was just 15 seconds of uninterrupted weeping

  2. Anonymous

    Real gentleman development: commit the code, the ADR, and a narrated director’s-cut .mp3 - then fail CI if the transcript drifts from git blame

  3. Anonymous

    Finally, a documentation strategy that combines the searchability of comments with the clarity of that one architect who explains everything through interpretive dance at standup

  4. Anonymous

    Ah yes, voice-recorded code documentation - because nothing says 'maintainable codebase' like a 47-minute audio file explaining why you chose that particular regex pattern at 3 AM. Bonus points if you include the existential crisis you had while debugging the edge cases. Future developers will surely appreciate hunting through your spoken-word album to understand why `getUserData()` actually deletes users on Tuesdays

  5. Anonymous

    Audio comments stored in Git LFS: fantastic context until a Sev1, when grep returns a 40‑minute monologue and git blame links to Past Me’s podcast

  6. Anonymous

    Voice docs: because future maintainers deserve to hear the regret in your voice behind every unchecked TODO

  7. Anonymous

    Tried upgrading comments to a 40‑minute voice-over; PR came back: looks fine, but we can’t grep an MP3 - write an ADR, not a podcast

  8. @pavloalpha 5y

    cumment

  9. Deleted Account 5y

    real men use codes that belong to 30 years ago without any comment

    1. @RiedleroD 5y

      real men code in assembly

      1. @sylfn 5y

        real men code.

        1. @RiedleroD 5y

          real men .

          1. @sylfn 5y

            real

            1. @RiedleroD 5y

              ̣

              1. @sylfn 5y

                That dot outside of text scares me

                1. @ZgGPuo8dZef58K6hxxGVj3Z2 5y

                  Lol

                2. @RiedleroD 5y

                  ̣̣̣̣̣̣I can make it brighter somehow look: ̣ vs ̣̣̣̣̣̣̣̣

                  1. @RiedleroD 5y

                    alt-gr+shift+ö on my keyboard, but idk if it's on english keyboards as well

                    1. @ZgGPuo8dZef58K6hxxGVj3Z2 5y

                      People who work at unicode standards are bored af

              2. @ZgGPuo8dZef58K6hxxGVj3Z2 5y

                How this works lol

  10. @interfejs 5y

    just name your fucking variables properly

  11. @nuntikov 5y

    Wtf

  12. @nuntikov 5y

    That's actually a good idea

  13. @theodolu 5y

    Real men directly program hard drive with a magnet

    1. @RiedleroD 5y

      Real men just hit the computer until it does what they want

    2. @sylfn 5y

      real men dont use hard drive, they use ssd

      1. @CoolyFooly 5y

        real men don't use persistent storage, they use RAM

        1. @RiedleroD 5y

          real men don't use storage at all, they directly insert electron into the CPU pins

          1. @RiedleroD 5y

            scrap that, real men calculate everything in their head

        2. @Odinmylord 5y

          Writes code Shuts down computer Loses it Leaves *Chad image*

          1. @sylfn 5y

            have you ever heard about persistent OSes? ah no they use persistent storage...

            1. @Odinmylord 5y

              If you use them you aren't a real man

      2. @theodolu 5y

        Pussies use ssd

        1. @NiKryukov 5y

          real men use floppy

          1. @Dobreposhka 5y

            real men are women

          2. @theodolu 5y

            They punch holes in cardboards with their colt

          3. @sylfn 5y

            real men use paper and pen

Use J and K for navigation