Join devRant
Do all the things like
++ or -- rants, post your own rants, comment on others' rants and build your customized dev avatar
Sign Up
Pipeless API
From the creators of devRant, Pipeless lets you power real-time personalized recommendations and activity feeds using a simple API
Learn More
-
When you implement a 3rd party payment system, and it doesn't work... and their support can't fix the problem... So you debug their code and send them the revised code and they update their GIT repo and update their documenting.
14 -
0. Plan before you code. Document everything. You won't remember either your idea or those clever implementations next week (or next month, or next year...).
1. Don't hack your way through, unless that's what you intend to do. Name your variables, functions etc. neatly: autocomplete exists!
Protip: Sometimes you want to check a quick language feature or a piece of code from one of your modules. Resist the urge to quickly hack in the test into your actual project. Maintain a separate file where you can quickly type in and check what you're looking for without hacking on your project (For example, in Python, you can open a new terminal or IDLE window for those quick tests).
2. Keep a quiet environment where you can focus. Recommend listening to something while coding (my latest fad is on asoftmurmur.com). Don't let anything distract you and throw your contextual awareness out of whack.
3. Rubber ducks work. Really. Talking out a complex piece of logic, or that regex or SQL query aids your mind greatly in grasping the concept and clearing the idea. Bounce off code and ideas with a friend or colleague to catch errors and oversights faster. Read more here: https://en.wikipedia.org/wiki/...
4. Since everyone else is saying this (and because it merits saying), USE VERSION CONTROL. Singular most important thing to software development aside from planning and documenting.
5. Remember to flout all of the above once in a while and just make a mess of a project where you have fun throwing everything around all over the place. You'll make mistakes that you never thought were possible by someone of your caliber :) That's how you learn.
Have fun, keep learning!3 -
Navy story time, and this one is lengthy.
As a Lieutenant Jr. I served for a year on a large (>100m) ship, with the duties of assistant navigation officer, and of course, unofficial computer guy. When I first entered the ship (carrying my trusty laptop), I had to wait for 2 hours at the officer's wardroom... where I noticed an ethernet plug. After 15 minutes of waiting, I got bored. Like, really bored. What on TCP/IP could possibly go wrong?
So, scanning the network it is. Besides the usual security holes I came to expect in ""military secure networks"" (Windows XP SP2 unpatched and Windows 2003 Servers, also unpatched) I came along a variety of interesting computers with interesting things... that I cannot name. The aggressive scan also crashed the SMB service on the server causing no end of cute reactions, until I restarted it remotely.
But me and my big mouth... I actually talked about it with the ship's CO and the electronics officer, and promptly got the unofficial duty of computer guy, aka helldesk, technical support and I-try-to-explain-you-that-it-is-impossible-given-my-resources guy. I seriously think that this was their punishment for me messing around. At one time I received a call, that a certain PC was disconnected. I repeatedly told them to look if the ethernet cable was on. "Yes, of course it's on, I am not an idiot." (yea, right)
So I went to that room, 4 decks down and 3 sections aft. Just to push in the half-popped out ethernet jack. I would swear it was on purpose, but reality showed me I was wrong, oh so dead wrong.
For the full year of my commission, I kept pestering the CO to assign me with an assistant to teach them, and to give approval for some serious upgrades, patching and documenting. No good.
I set up some little things to get them interested, like some NMEA relays and installed navigation software on certain computers, re-enabled the server's webmail and patched the server itself, tried to clean the malware (aka. Sisyphus' rock), and tried to enforce a security policy. I also tried to convince the CO to install a document management system, to his utter horror and refusal (he was the hard copy type, as were most officers in the ship). I gave up on almost all besides the assistant thing, because I knew that once I left, everything would go to the high-entropy status of carrying papers around, but the CO kept telling me that would be unnecessary.
"You'll always be our man, you'll fix it (sic)".
What could go wrong?
I got my transfer with 1 week's notice. Panic struck. The CO was... well, he was less shocked than I expected, but still shocked (I learned later that he knew beforehand, but decided not to tell anybody anything). So came the most rediculous request of all:
To put down, within 1 A4 sheet, and in simple instructions, the things one had to do in order to fulfil the duties of the computer guy.
I. SHIT. YOU. NOT.
My answer:
"What I can do is write: 'Please read the following:', followed by the list of books one must read in order to get some introductory understanding of network and server management, with most accompanying skills."
I was so glad I got out of that hellhole.6 -
How to present your app/library more positively:
It's slow and bulky -> "It's feature-rich"
It hardly does anything -> "It's lightweight"
It has no comments -> "It's self-documenting"2 -
Subject: FW: Twilio integration
Date: 20th June
From: <program-lead>
PractiseSafeHex I need you to fill in the dev completion dates for the Twilio task for the mobile team by EOD today. Backend have already supplied theres. Otherwise I will be forced to mark the task as “At Risk”. Please let me know if there is an issue or you are blocked.
—- Begin Forwarded Mail ——
Subject: Twilio integration
Date: 18th June
From: <program-lead>
Hi All,
Documenting today’s meeting minutes. Backend confirmed they will handle the Twilio integration from their side entirely. There will be no mobile work required for this task.
Thank you,
<program-lead>11 -
I applied for a backend job. Somehow i ended up doing frontend. Ok whatever the pay is alright and i dont mind doing js. But then i see the backend team doing absolute horseshit, stacking up overhead and not even fucking documenting the endpoints, i get mad.
And now our sysadmin left so there is no fucking server and i cant run locally because of 9trillion config files (remember the overhead part?) and the pm is nagging me to get the site done WHEN THERE IS NO FUCKING SERVER. WHAT DO YOU WANT FROM ME, SET IT ALL UP AGAIN? THATS NOT MY FUCKING JOB YOU IMBECILE FUCKFACE.8 -
#1
Thinking Edge might actually be the next new browser.
And then using it for a few weeks.
#2
Not documenting my code 😥6 -
Ok you fucks that don't believe in documentation - me included.
Document your shit, because one day, one day some dumb fuck is going to have to recreate your over engineered bullshit of a system and scale it up.
What would fucking be useful right now is ANY god forsaken insight into what in the flying fuck your code is doing, or not doing, or why it makes queries to a database with no fucking records in it 🤦♂️ and then attempts to use that data... in case it did exist.
There's nothing like unpicking a mess of bullshit, and documenting it, and then have to remake it on a new platform.
Documention saves lives kids, maybe your own life one day😬16 -
A small bug is found.
Chad dev:
😎 *Exists*
> Writes a simple ad hoc solution in a few lines
> Self documenting code with constant run time
> No external dependencies needed
> Fixes the bug, easy to test and does not introduce any new issues
That guy nobody likes (AKA. regex simp coder):
🤡 'This can be "simplified" into oNE LiNe'
> Writes a long regex expression that has to line wrap the editor window several times
> Writes an essay in the comments to explain it's apparent brilliance to the peasant reader
> Exponential run time (bwahahah), excessive memory requirements
> Needs to import additional frameworks, requires more testing that will delay release schedule
> Also fixes bug but the software now needs 2x ram to run and is 3x slower
> Really puts the "simp" in simplified, but not the way you would expect26 -
When I started learning to code I couldn't wait to become a 'senior dev' thinking I would spend all my time writing awesome code.
Now that I am a 'senior dev' and have the experience I now spend 90% of my time documenting & planning and even less time coding :'(9 -
I have a junior who really drives me up a wall. He's been a junior for a couple of years now (since he started as an intern here).
He always looks for the quickest, cheapest, easiest solution he can possibly think of to all his tickets. Most of it pretty much just involves copy/pasting code that has similar functionality from elsewhere in the application, tweaking some variable names and calling it a day. And I mean, I'm not knocking copy/paste solutions at all, because that's a perfectly valid way of learning certain things, provided that one actually analyzes the code they are cloning, and actually modifies it in a way that solves the problem, and can potentially extend the ability to reuse the original code. This is rarely the case with this guy.
I've tried to gently encourage this person to take their time with things, and really put some thought into design with his solutions instead of rushing to finish; because ultimately all the time he spends on reworks could have been spent on doing it right the first time. Problem is, this guy is very stubborn, and gets very defensive when any sort of insinuation is made that he needs to improve on something. My advice to actually spend time analyzing how an interface was used, or how an extension method can be further extended before trying to brute-force your way through the problem seems to fall on deaf ears.
I always like to include my juniors on my pull requests; even though I pretty much have all final say in what gets merged, I like to encourage not only all devs be given thoughtful, constructive criticism, regardless of "rank" but also give them the opportunity to see how others write code and learn by asking questions, and analyzing why I approached the problem the way I did. It seems like this dev consistently uses this opportunity to get in as many public digs as he can on my work by going for the low-hanging fruit: "whitespace", "add comments, this code isn't self-documenting", and "an if/else here is more readable and consistent with this file than a ternary statement". Like dude, c'mon. Can you at least analyze the logic and see if it's sound? or perhaps offer a better way of doing something, or ask if the way I did something really makes sense?
Mid-Year reviews are due this week; I'm really struggling to find any way to document any sort of progress he's made. Once in a great while, he does surprise me and prove that he's capable of figuring out how something works and manage to use the mechanisms properly to solve a problem. At the very least he's productive (in terms of always working on assigned work). And because of this, he's likely safe from losing his job because the company considers him cheap labor. He is very underpaid, but also very under-qualified.
He's my most problematic junior; worst part is, he only has a job because of me: I wanted to give the benefit of the doubt when my boss asked me if we should extend an offer, as I thought it was only fair to give the opportunity to grow and prove himself like I was given. But I'm also starting to toe the line of being a good mentor by giving opportunities to learn, and falling behind on work because I could have just done it myself in a fraction of the time.
I hate managing people. I miss the days of code + spotify for 10 hours a day then going home.11 -
I have this teacher who focuses so much on documentation that I hardly get to code sometimes. The worst experience with that teacher was with a project I think about two years ago. Every time I came up with (modified) documentation (we have to document EVERYTHING before allowed to start programming) she would turn me away with some bs argumentation and also point out non existing English grammar errors (my English is way better than hers). After nine weeks of documenting (so, no single line of code yet and projects take ten weeks) she gave me the green light. Then at 'delivery' she had the fucking balls to to tell me that MY CODE WASN'T THAT STABLE AND GOOD YET.
I WAS LITERALLY HAVING A LIVE RAGE ATTACK OVER THERE.4 -
Day 1 of my 1000 job applications TikTok challenge
Goal:
- apply to 9 different jobs per day
- see if i can break the Guinness World Record of being rejected 1 thousand (1000) times
Stats so far:
- 9 job applications
- 0 replies
- 0 hires
Will be documenting this on devrant too
7 -
Rant::aboutMyself(my_code){
Wrote 500+ lines of code without proper documentation. Got 200 little bugs. Got frustrated. Gave up on code. Started documenting it. Step by step. Resolved many silly mistake while documenting the code. Completed documentation. Run the program . Bugs reduced to 10. I'm sooo happy. I LOVE DOCUMENTATION 😍
}2 -
Self documenting code is a fucking myth you bloody sheep.
Write “self documenting code” then add a fucking comment or two explaining why the fuck the code deserves should be there because nobody can see what the fuck it is doing or understands how the whole collection of microservices works. I’m sick of spaghetti code bullshit full of accidental redundancy because it is impossible for anyone to realize why something is there at a glance.
I renamed different “Contract” classes today by adding numbers before code review.
Contract
Contract1
Contract2
Contract3
All of these classes are supposed to be the same but somehow they aren’t and you self documenting dumbasses missed it. Don’t gripe about the numbered classes in the repo… fix the fucking code and collapse the classes so we don’t have four sections of code describing the same fucking structure from a http get with different interfaces because four people couldn’t read the whole like some fucking computer.11 -
Just came back to an old project I haven't touched in a while and realized I did an awesome job documenting it. It's almost annoying my level of detail. I'm proud of my past self for thinking of me now.3
-
I'm finally realising my long time dream and making a programming language. It's a functional language resemblent in both appearance and usage to lambda calculus. I'll mostly be making plans down to the finest details until the end of summer, at which point if I can gauge the challenge I can hopefully submit this as a graduate project.
This is the first in a series of articles documenting my progress:
https://lbfalvy.github.io/blog/... -
Code is not self documenting..
reading 10k+ lines of business logic does not take the place of well defined documentation.
Mic drop.28 -
I hired 2 fresh out of school junior devs to work with me on my old web app.
They were brilliant, knew a lot of things, and were motivated.
They started complaining about how the code was shit, the db was shit, there were no best practices, the technology was old, bug fixing was boring, no comments in code.
I felt bad, very bad during 3 years, because they were absolutely right. I tried to work with them through better coding practices, rewriting, documenting etc.
Now they both have left.
I'm alone maintaining and evolving the application.
And I start to come across the code THEY developed.
What a bunch of shit. SQL queries bringing down the server. Duplicate code, because they didn't want even read the old one. Useless comments.
Performance killing functions. Exceptions swallowed without mercy. I have to clean up they poop.
I feel somewhat better, though. The application is still growing and holding the ground after many years and generating at least 800K$ per year in revenues.
Maybe better, but sad. I really wanted to share the project with somebody else but I failed, and I'm left alone....12 -
Most ignorant ask from a PM or client?
Migrated to SharePoint 2016 which included Reporting Services, and trying to fix a bug in the reporting services scheduler, I created a report (aka, copied an existing one) 'A Klingon Walks Into a Bar', so it would first in the list and distinct enough so the QA testers would (hopefully) leave it alone.
The PM for the project calls me.
PM: "What is this Klingon report? It looks like a copy of the daily inventory report"
Me: "It is. The reporting service job keeps crashing on certain reports that have daily execution schedules."
PM: "I need you to delete it"
Me: "What? Why? The report is on the dev sharepoint site. I named the report so it was unique and be at the top of the list so I can find it easily."
PM: "The name doesn't conform to our standards and it's confusing the testers."
Me: "The testers? You mean Dan, you, and Heather?"
PM: "Yes, smartass. Can you name the report something like daily inventory report 2, or something else?"
Me: "I could, but since this is in development, no. You've already proofed out the upgrade. You're waiting on me to fix this sharepoint bug. Why do you care what I do on this server? It's going away after the upgrade."
PM: "Yea, about that. We like having the server. It gives us a place to test reports. Would really appreciate it if you would rename or delete that report."
Me: "A test sharepoint reporting services server out of scope, so no, we're not keeping it."
PM: "Having a server just for us would be nice."
Me: "$10,000 nice? We're kinda fudging on the licensing now. If we're keeping it, we will be required to be in compliance. That's a server license, sharepoint license, sql server license, and the dedicated hardware. We talked about that, remember?"
PM: "Why is keeping that report so important to you? I don't want to explain to a VP what a Klingon is."
Me: "I'm not keeping the report or moving it to production. When I figure out the problem, I'll delete the report. OK?"
PM: "I would prefer you delete the report before a VP sees it."
Me: "Why would a VP be looking? They probably have better things to do."
PM: "Jeff wants to see our progress, I'll have to him the site, and he'll see the report."
Me: "OK? You tell Jeff it's a report I'm working on, I'll explain what a Klingon is, Jeff will call me a nerd, and we all move on."
PM: "I'm not comfortable with this upgrade."
Me: "What does that mean?"
PM: "I asked for something simple and I can't be responsible for the consequences. I'll be documenting this situation as a 'no-go' for deployment"
Me: "Oookaayyy?"
I figured out the bug, deleted the 'Klingon' report, and the PM couldn't do anything to delay the deployment.4 -
NO FUCKING PROGRAM IS SELF DOCUMENTING. I DON'T CARE IF ITS A HELLO WORLD PROGRAM, DOCUMENT IT!!!
😡🔫1 -
- Back in October 2019 -
- Me: Hey, these two servers are having weird problems. Several services we use stop functioning every 7-10 days. I can temporarily fix them by taking them off the domain and putting them back on, but I don’t know why they’re happening or what further damage this workaround causes.
- Boss: Thats not good. Well. Keep doing the fix when it’s needed.
- Me: We should really reach out to someone at Microsoft through our support plan. I have no idea how to fix any of this and it’s making our Hyper-V environment very unstable.
- Boss: K. Let’s not worry about that now, let’s just keep working around it.
- In January 2020 -
- Me: Hey boss. More and more errors are generating from these servers. I’ve created a log of everything Ive found to hand off to a support agent. We really need to.
- Boss: Okay. Let’s talk to our internal team that uses Hyper-V and see what they did since they don’t have any problems.
- Me: Its not Hyper-V specific. It’s stemming from AD and authentication. It causes problems even without Hyper-V installed, so I don’t think it will help.
- Boss: K. Let’s just do what we can with what we got.
- Today, May 2020 -
- Me: Hey. The servers no longer work at all, and the workaround has no effect anymore. I’m completely stalled on my project now and have nothing to do.
- Boss: What?? What happened to them?
- Me: *Sends 17 page PDF file documenting all found issues, errors, warnings, and weird anomalies in both servers, as well as troubleshooting steps I’ve already performed*
- Boss: None of this makes any sense. I need you to start troubleshooting right away.
- Me: But... I can’t... *Sends screenshots of errors having no search results on the web, screenshots of Microsoft Support Techs on forums telling me we need to open tickets with Microsoft directly, other reasons why I’m completely blocked*
- Boss: Keep trying to figure it out. We need this resolved as soon as possible and we can’t let it happen again in the future.
Now I’m completely alone in our office, bitterly staring at the servers, trying to force an epiphany on how to fix these dumb boxes.5 -
The more someone talks about how code should be "self documenting" the less likely their code is to actually be "self documenting"5
-
So... I've got a confession to make.
I'm no longer a Dev. After the disaster that was my last commercial gig, I went and got a sec Ops role... And I love it. It's just technical problem solving and explaining all the way.
Don't get me wrong, I still love to code. But that's exactly the thing. As a commercial developer employed by corporations, I spent close to 80 % of my time not coding, but in useless meetings, or trying to figure out just what my colleagues thought was "common sense", reverse engineering their work and documenting how to get it running, etc. Basically, fixing shit for braindead academics with next to no real world experience.
Now, when I code, I get to do it on my own terms, with my own stack and as much comments and docs as I want to have. I own my time, and the only ones that are allowed to interrupt me is the local fire department.
I can do what I'm fucking passionate about and leave the rest for the useless people.4 -
Client dev inlined all my single line functions as it's "more efficient".
Speechless is not the word.14 -
Step 1: create genius-level Excel spreadsheet
Step 2: wait 7-10 days
Step 3: realise you're an idiot for not documenting what all your genius code does so it will take just as long to unpick it as to start from scratch
Step 4: complain on devrant even though it's your own fault
:( -
So my wife bought a really old android tablet (it's on gingerbread lol) so I've decided to bring it up to android pie, yes that means building a custom ROM, from scratch, for a 7 year old device. I will be documenting my progress and if I fail then at least it will be published research as the memory optimization in android pie is so much smoother now it should be good. If it fails I shall try to build android go to the device.
It's still got a 1.5ghz processor and 1gb of ram which should be fine so here's hoping.23 -
Looking through our gitlog today and see 3 PR's from our "lead developer". 2 of these were removing a single blank line from a class, and the 3rd was adding one back in. None of these had any title or commit messages on the PR's. This is a guy that talks down to everyone and deliberately makes other devs feel insignificant, saying he's too busy to write documentation and it's not needed because his uncommented code is self documenting. But hang on he's not too busy to waste time with pointless non-functional PR's that only remove a couple of blank lines? Scratching my head in disbelief that some devs think they can get away with shit like this. How about you drop the ego and actually try and work in collaboration with the other devs.2
-
Nothing like writing summary comments on methods to make you feel smart. It's like:
<summary>
ObviousWellNamedMethod is a method that does obvious well named thing
</summary>
<param name="WellNamedObviousParameter">Represents the well named obvious thing used in the obvious well named method</param>
I hate coding standards sometimes.4 -
Worst thing you've seen another dev do? Here is another.
Early into our eCommerce venture, we experienced the normal growing pains.
Part of the learning process was realizing in web development, you should only access data resources on an as-needed basis.
One business object on it's creation would populate db lookups, initialize business rule engines (calling the db), etc.
Initially, this design was fine, no one noticed anything until business started to grow and started to cause problems in other systems (classic scaling problems)
VP wanted a review of the code and recommendations before throwing hardware at the problem (which they already started to do).
Over a month, I started making some aggressive changes by streamlining SQL, moving initialization, and refactoring like a mad man.
Over all page loads were not really affected, but the back-end resources were almost back to pre-eCommerce levels.
The main web developer at the time was not amused and fought my changes as much as she could.
Couple months later the CEO was speaking to everyone about his experience at a trade show when another CEO was complementing him on the changes to our web site.
The site was must faster, pages loaded without any glitches, checkout actually worked the first time, etc.
CEO wanted to thank everyone involved etc..and so on.
About a week later the VP handed out 'Thank You' certificates for the entire web team (only 4 at the time, I was on another team). I was noticeably excluded (not that I cared about a stupid piece of paper, but they also got a pizza lunch...I was much more pissed about that). My boss went to find out what was going on.
MyBoss: "Well, turned out 'Sally' did make all the web site performance improvements."
Me: "Where have you been the past 3 months? 'Sally' is the one who fought all my improvements. All my improvements are still in the production code."
MyBoss: "I'm just the messenger. What would you like me to do? I can buy you a pizza if you want. The team already reviewed the code and they are the ones who gave her the credit."
Me: "That's crap. My comments are all over that code base. I put my initials, date, what I did, why, and what was improved. I put the actual performance improvement numbers in the code!"
MyBoss: "Yea? Weird. That is what 'Tom' said why 'Sally' was put in for a promotion. For her due diligence for documenting the improvements."
Me:"What!? No. Look...lets look at the code"
Open up the file...there it was...*her* initials...the date, what changed, performance improvement numbers, etc.
WTF!
I opened version control and saw that she made one change, the day *after* the CEO thanked everyone and replaced my initials with hers.
She knew the other devs would only look at the current code to see who made the improvements (not bother to look at the code-differences)
MyBoss: "Wow...that's dirty. Best to move on and forget about it. Let them have their little party. Let us grown ups keeping doing the important things."8 -
Sins? I don't want to keep you up all night, so here are some highlights.
Fucking with clients and employers who fuck with me first, or waste my time.
Occasionally not documenting my code (I'm actually pretty good about this), then bitching about poorly documented code.
Honestly wishing other people in the office would *actually* explode, or die engulfed in flames.
Working drunk and/or stoned.
Getting pissed off when I have to do something in a stupid way, or use a workflow that I don't like.
Seriously fucking up out of either arrogance or stupidity, then blaming it on something else.
Zoning out, skipping work, or sleeping in and billing for it (see sin #1).
But my greatest sin? That honor's got to go to becoming a developer in the first place.
I wasn't always a professional asshole, but I fucking am now.1 -
Dear fellow project member,
I agree that most code should explain itself, but if you need to use a certain method which requires you to pass several different values of the same type and you just pass values as you like and then get, as you like to call it, 'unexpected behavior', then that is YOUR F***ING PROBLEM.
I DO know your thoughts about documenting code and I DO know you think documenting code only delays the progress, but if you for once could please CHECK THE DOCUMENTATION I WROTE, there would be no need to message me EVERY FIVE BLOODY MINUTES to complain about something that actually works when used right, just because you are too lazy to read the docs!
If you would do that next time, at least the time i spend writing documentation for our project would not be COMPLETELY WASTED! 😤
Kind Regards2 -
Want to fuck other developers? Then make a quite probable project name illegal without documenting it, nor providing any helpful information in the error messages.
I tried to name my Flutter test project flutter_test. Turns out that that name is reserved (it's a package). Fml. 🤦🏽♂️4 -
Doing and Code Review today... Not sure if this guy has really bad OCD, gets bored, or gets stuck and starts commenting the shit of things...
I'm not sure if I like it or hate it... typically "Good code should be self documenting" but this actually might be acceptable... code on the left, 10K foot view on the right?
4 -
Lol I suck. Learnt coding without a degree in it, enough to be functional. Got an internship at a good place. Made code that worked but didn’t know enough on documenting and testing and can’t give enough time anymore on it to make it reproducible.Actually joined a CS program this fall!6
-
People rant here about how they hate documenting things or writing tests or whatever.
Yes these things are not the most interesting but I have a feeling that we are forgetting about most horrendous of tasks - estimating. Especially in agencies. Especially related to altering legacy features. Especially big projects.
I mean, I'm spending time doing something that is basically dev's Voo Doo, hoping that I will be right... and usually I'm not.6 -
Received a complaint that the year dropdown list isn't far enough (ends at 2022). They wanted it to go all the way to 2027. My script handles this by getting the current year then add 5 to it and it generates the values in the dropdown list. All I had to do was change from '5' to '10' in the config puppet files. Contractually, any source code changes needs to be documented and informed to the client. I followed suit, documenting how I am going to make the change. This is new as it involves using git to commit the changes and pull it in the server that talks to the git server. This shouldn't take more than a minute to fix.
Submitted and wanted to finish this today. Client decided to wait til next week to complete the code change to fix the complaint. A work that can be done in a minute is now dragged to a week. FFFFFFFFFFFFFFFFFFFFFFUUUUUUUUUUUUUUUUUUUUUU -
Documenting what failed and what did not work is equally important as documenting things which worked out ...2
-
You have a JavaScript application. You have to keep up with stupid devs that don't know TypeScript because you don't have the time to let them study it and they get demotivated when they can't do stuff so fine, you keep it JS. You use JSDoc to write the documentation. You miss using TypeScript so you start doing some @typedef's. Oh your linter gets it and starts behaving as a substitute of TypeScript. You get excited and write more and more @typedef's! ... until they get so complicated that you start documenting *that*...3
-
"Hey, maybe we should do this! Why aren't we doing this?"
We are, this is on the roadmap and we just discussed it last week. Why bother discussing and documenting it if you are not even gonna read it? I'm tired of repeating the same thing over and over again.1 -
Yesterday i realised the importance of documenting everything step by step . I was told to port an driver/application that we made for linux 4.1 to a 4.9 kernel . Eventhough i did already port another similar application to the same , didnt remember what are things that i did.. Thank God ..If not for the constant pestering of my colleagues to document each step.. I would have been stuck in that island for 2 more days ..1
-
There should be a NGO for properly destroying scammers. And I'm not talking about documenting the scams. I'm talking about having the resources to deny them service, find their identities and report them to authorities. Even meddle with their computers using malware.
These people are preying on mostly elderly people and stealing their money.3 -
OK people, I don't need a novel written for every line of code, but PLEASE STOP trying to tell me that "yOuR coDe sHouLd bE sELf dOcUmeNtiNg aNd cOmMenTs mEaN iT's aUtoMaTiCaLLy bAd". That's a bunch of BS. I can't begin to tell you how many times I've saved my own butt by dropping a "this call can't be awaited; causes the library's internal API to throw an error" comment in my C#, or a "can't use double quotes here; doesn't work right for some reason" line in my JavaScript. Sometimes there are very good but un-obvious reasons why something was done a certain way, even though it looks like it could be done better. And don't try to tell me "the tests will catch it". Let's be realistic here, nobody has 100% test coverage on any project that's much more than "Hello World". And even if the tests DID catch it, why waste the time when you could just write a comment?
P.S.: This is not directed at anyone on here specifically. It's directed at all the devs I've met IRL and the comments I've seen on SO, who think that comments must be bad.12 -
We were documenting a feature which has system wide affect. We’ll be delivering it to customer on Monday.
So we’ve asked the colleague who worked on it about how it works and asked few follow up questions that arise during the documenting. All were good.
Comes Friday when I had a question as some things didn’t add up and I checked the source. To my surprise the very core operation colleague explained us works in exact opposite way. I kid you not in %50 percent of the documentation we ramble about why it was implemented this way since it is faster/safer best practices bla bla.
Moreover we’ve already had some exchange with the customer and we informed(misinformed) them about this core operation...
Also changing the behavior will reduce the overall speed as it will cause extra branchings. Other option is to rewrite the documentation and inform(re-convince) the customer. If it was me I wouldn’t trust us anymore but we’ll see.
I really don’t know what to say about this fucker why would you say something if you’re not sure of it or why the fuck you didn’t confirm in the last 3 weeks....
Anyway we have a meeting on Monday morning to discuss how to proceed, that’s gonna be fun!1 -
Smashing on the keyboard
with 3 screens infront of my face
i spot a nasty bug,
In one of the features someone else made,
I called their office for aid,
But found no one is there to be
Of any aid to my sorry ass,
Now i have to debug the whole thing,
Oh,
Documenting code
Documenting code
Why didnt you document the damn thing
At least tell me you left some comments
To help debug thy algo tree
Oh ...
:'(
1 -
I want to program everyday for a whole year because I want to use the programming knowledge that I learned and use it in ways that will make me think outside the box. Hopefully, I can grab freelance work as a Web Developer, which has been in high demand these past few years.
I'll be documenting the process on my YouTube channel, which I'll share when I publish the first video.
I will NOT procrastinate... I WILL DO THIS!!5 -
Documenting. Starting Microsoft Word to fill in a preconfigured template. It contains two numbered lists, but the numbering incorrectly continues from the first list to the second. Right-click > numbering > Set Numbering Value > Start new list. Bang! MS Word fucks up the complete formatting, margins, tabs, paragraph spacing... But the list numbering still continues from the first list to the second.
I SO FUCKING HATE MICROSOFT WORD FOR WINDOWS!!!7 -
So what's up with some devs, QAs and managers that create bug tickets with little to no information on what is the actual bug? I can semi-understand in the case where you document it only for you to read later.
Fuck you if you think that a ticket with only a title saying "fix all the bugs for this release" or "this feature is not working" is an appropriate way of documenting a bug.
Fuck you even more if when you are being asked to provide more info to reproduce the issue so someone else can actually be sure it is fixed or not (environment, steps, expected result, actual result, etc.), you simply say that you don't have the time for it and documenting tickets is a waste of time.
Hiring YOU was a waste of time!4 -
Documenting your code is like peeing. You'll rather just keep coding until you no longer have a choice 😂1
-
Not commenting and documenting as I write. I always wait till after and then I get bored of it while doing it...
-
Best: chief university lab position, 12 yrs as a 👨🏫 system engineer teacher, really need a break, updating me as a pro.
Worst: last chief just left email with CISCO passwords. No F* VLANS reference, no technical manual, deleted all Sh* documents on PC.
So I about 4 days no internet on university, reseted 25+ CISCO switches, reorganizing fibers, all week 💤 6am-11pm or more. VTP server core nice and clean, nice VLans, ClearOS formated an licensed, ubnt portal for Wifi.
December, organizing all the administrative stuff. We are back stable and documenting. Moving and painting office, delegation of staff.
Now in vacations with a “tepache 🍻 “ 🍍2 -
i fucking hate bit shifting operation fuckery
fuck your clever math and shit
also documenting what represents what in an idiot proof way so i can easily consume it8 -
I spent the whole day documenting a framework I recently built for my team so they would know how to use it.5
-
Alright, fellow coders. If I am required to spend 6-8 hours documenting your steaming pile of shit, MAKE SURE IT FUCKING COMPILES SO I CAN CHECK THE FUNCTIONALITY AND GET SCREENSHOTS! IT IS ALMOST NOON! I DONT WANT TO STAY LATE! Bitches.4
-
I get really angry when my friend (has only ever taken a web design class in high school that taught only basic html) tries to preach to me that you shouldn't have to worry about writing readable code along with documenting it so long as it works the way you want it to.1
-
Pretty much Python automation on steroids.
https://github.com/konradhalas/...
Dacite is an integral part in it, cause it makes most auto generated API wrappers like Cloudflare API "maintenable".
Getting dicts, converting via Dacite to defined data classes...
Then using TOML to define e.g. output parameters (e.g. list of classes / properties one needs)...
... To export them via Pandas to anything what one needs.
It's just so comfortable.
Definining data classes, sprinkle the API calls and dacite in it, some definition via TOML, done.
Yes, lots of dark vodoo / behind the scenes magic... But ... It removes all this annoying fucked up boilerplate writing that takes ages and makes it frustrating.
As long as the data wrapper (e.g. clousflare API) generates Dicts, its really minutes to get an export working.
If you know the pain of having to deal with multiple accounts, different formats (e.g. different companies)… hours of manual copy pasting to aggregate the data etc.
Then you can maybe understand why I love this so much.
Data classes and dacite makes painful confusing workflows so much nicer and self documenting, I get wet in my pants while writing this. :) -
"God we've got an awful lot of technical debt, there's no process for anything here, no one knows how to use it, how it works or what even what it really does. Should we try to spend some time documenting and fixing that since this problem is going to keep cropping up again and again and the guy who wrote it left 2 years ago"
"Nah, the execs want features, fuck the fact that we are constantly struggling to meet deadlines due to being horrendously understaffed and everything takes 3 times as long as it should due our crippling technical debt. Lets keep hacking away with our old rusty saw instead of taking 10 mins to sharpen it"5 -
Second big school project. Designed for at least 2 people. Quite a lot of work for the given time but not impossible to do, as I thought. Oh boy was I wrong.
My partner and I chose a networking project which included setting up a ESXi-Server, a VM (with Windows Server 2008 R2) and a router. We are both not unknowledged so I thought this would be easy-going.
I quickly recognised that my partner liked to spend his time at home rather than actually doing something so I ended up doing nearly everything.
When it came to documenting everything he tried to write something, but it had so many mistakes i had to correct it over and over again.
I asked him multiple times, if we should split and he denied every time and promised to work harder.
End of that story was him being expelled from school because of to many missed lessons and me finishing the project alone. Got a B+ for it.1 -
When your mostly done code that you spent time on documenting and keeping clean gets handed over to the sloppiest dev on the team. Because that dev is out of tasks and you got other work that moved up in priority. I really hope he doesn't ruin everything :(3
-
Something that really grinds my gears recently is ”black boxes”. I get a dll to work with, completly without documentation and any desceiptions. An hour later people asks me, ”so hows it going, done yet?”.
No, im not done yet and I probably wont be in any near future you fucking morons, start documenting your fucking software as normal human beings.2 -
Fuck you apache server...
Why did your dumb ass developers decide it was a good idea to not support "expect 100 continue headers". I seriously suspect that the devs were high smoking dragon dildo ashes like they were getting ready to get a whole chair shoved up their asses.
I wasted alot of time thinking i was getting a 417 http code because i fucked up my API implementation... No, it was the dumb apache server that decided to give me the finger.
Also, whoever built the HttpClient for .net framework 4... Fuck you too for automatically adding that dumb header to PUT requests and not properly documenting this or allowing for it to be disabled in a non hacky way.
I appreciate and enjoy solving coding problems... I, however, can't stand dumb decisions like the two above. -
I need to vent or I'm going to fucking explode like a car filled with bombs in motherfucking Iraq...
A couple of months ago I inherited a project in development from our team leader who was the sole developer on it and he was the one who designed every single thing in it.
I was told the project is clean, follows design patterns, and over all the code is readable and easy.
Those were all fucking lies.
See throughout the period he was working on it, I saw some of the code as it was going through some pull requests. I remember asking the dev why he doesn't comment his code? His response was the most fucking condescending shit I've ever heard: "My code is self-documenting"...
Now that I have full control over the code base I realize that he over engineered the shit out of it. If you can think of a software design pattern, it is fucking there. I'm basically looking at what amounts to a personal space given to that dev to experiment with all kind of shit.
Shit is way too over engineered that I'm not only struggling to understand what the hell is going on or how the data flows from the database to the UI and in reverse, I'm now asked to finish the remaining part and release it in 8 weeks.
Everything is done in the most complicated way possible and with no benefits added at all.
Never in my career have I ever had to drag my sorry ass out of bed to work because I always woke up excited to go to work... well except for the last 2 weeks. This project is now taking a mental toll and is borderline driving me crazy.
Oh, did i tell you that since he was the only dev with no accountability whatsoever, we DO NOT EVEN KNOW WHAT IS LEFT TO BE IMPLEMENTED?
The Project Manager is clueless.. the tickets board is not a source of truth because tickets set to resolved or complete were actually not even close to complete. FUCK THIS SHIT.
For the last week I've been working on 1 single fucking task. JUST 1. The whole code base is a mine field. Everything is done in the most complicated way and it is impossible for me to do anything without either breaking shit ton of other features (Loosely coupled my ass) or getting into fights with all the fucking libraries he decided to use and abuse.
1 whole week and I can't even get the task done. Everyday I have to tell the project manager, face to face, that I'm still struggling with this or that. It's true, but i think the project manager now thinks i am incompetent or just lazy and making excuses.
Maybe I'm not smart enough to understand the what and why behind every decision he made with this code. But I'm sick to my stomach now thinking that I have to deal with this tomorrow again.
I don't know if I'll make the deadline. But I'm really worried that when this is released, I'll be the one maintaining that nightmare of a code base.
From now on, if i hear a fucking developer say their code is "self-documenting" I will shove my dick + a dragon dildo + an entire razor gaming keyboard up their ass while I shoot their fucking knees off.
oh... and there are just a couple of pages of documentation... AND THEY ARE NOT COMPLETE.2 -
At the risk of starting a war, what are folks opinions on in-line comments?
Personally, I'm against them. Self documenting code for the what, SCM for the why.
Comments can get out of date if not maintained; code cannot lie.9 -
So I joined a pretty big organization, and am working here for like the last 4 months. Barely wrote any code, mostly I have been documenting stuff, and testing stuff of other devs.
So I had a doubt regarding a functionality, like what I asked a senior dev was, Where exactly is this logic implemented in the codebase so that I can refer it. He was like, you are supposed to know it since you have worked on a testing ticket of it. And if I ask the manager such questions, he would be pissed off. My point of view is that yes, I might have seen that logic, and it might have been explained it to me once, but at that point of time, I did not knew about which functionality it was being used for. am I in the wrong here? Am I not paying enough attention to the code base given It's my 4th month here?2 -
When I'm reviewing code that I'm soon to be working on, I like to add comments to document things that aren't self-documenting.
When I encounter something I have no fucking idea about, I usually add:
// NFI
It's my "safe for work" way to indicate that I literally have no fucking idea what they were attempting.
So I'm curious, does anyone have their own comment "codes" that are safe for commits, but translate into something more awesome?4 -
Wow fuck today. I took the day off to watch the eclipse yesterday so coming in today was like Monday squared. Right off the bat I have somebody from last week that I had spend around 8 hours working to get their system right call in and tell me they were cancelling even though everything just got working right.
Also got tasked with documenting the servers which wouldn’t be rant worthy if the dev that set them up didn’t get cranky whenever I ask for credentials or even a rough overview of how the server stack is configured. Then I get a ticket about how a customer is going to get his data from his ‘web guy’ but this customer has been keeping his data in our system for the better part of a decade. Wtf you getting bro? And who is this web guy? What data does he have? Nobody seems to know. And just to smear shit on top it turns out I swapped the addresses on the car parts I sold on eBay and now I have to do 2 returns and cross ship and almost definitely get negative feed back. Fuck everything.
All this before lunch. After lunch I still have the same problems but at least I got chicken!1 -
Not a rant, just the completion of a very demanding and interesting task for this week.
Wrote a whole data scheme for this enterprise app my company is developing. Very proud of it, since it has a very restricted size, multiple layers of encryption and data verification, several user types with different requirements, and it all has to be rock solid in an offline environment.
The punchile is...I enjoyed writing the documentation for the whole package more than I should, I guess...spent the whole day being very thorough and documenting every member, function, constructor and exception.
Feelin fabulous.
-
Stating the obvious when writing comments. 🙈
I used to this when I was starting to learn how to code and let someone read it, 'cause it's better to have comments than nothing, right? 😂 I was wrong.
But that led me to improve writing informative comments and self-documenting codes. -
I can't share it but I basically just wrote an email at work that's pretty much a rant.
Basically something like should we use Java for this new component? It needs to communicate with our existing server written in JS.
And someone was like no we should stick with JS and Node because that's what the website is written.
And so I'm like wtf... It doesn't matter as long as everyone agrees to follow the same rules... And then added a part about commenting and documenting stuff being more important so I don't need to keep doing CSI on the codebase when something blows up.2 -
Im not involved in any projects at all anymore. My direct collegae is planned fully for the coming months. It’s clear everyone just wants to get rid of me.
If i ask the teamlead for feedback i dont get any.
If i ask the manager for feedback i get to hear he talked to the lead but he has no time to talk with me.
Giving me a compliment hurted his guts. Ive spend weeks just documenting bullshit.
All im allowed is to help out with tiny annoying tasks and i need to do them 10000% perfect. I’m a human, i’m not perfect. I accept the fact i’m not and so should they.1 -
Debugging a task, that's sending emails to too many customers.
Supervisor: "Never mind, just test in production, there is a dry run flag for the tasks."
Just in case I test locally...
Flags tried:
--dryrun="TRUE" => Error, failed to send mail.
--dryrun=TRUE => Error, failed to send mail.
--dryrun="true" => Not trying to send mail.
If it's THIS PICKY a little more documentation would be nice.
And by a little more I mean: more than the task base class in a giant php monstrosity without phpdocs expecting its code to be self-documenting. -
Hi fellow ranters,
Its been awhile since I last was here posting stuff..
So, I've commited to my effords getting shit done in golang. And I met a lot of painpoints, and I mean...
A
Lot
Of
Them.
Anyway, most of them are solvable by changing mindset or having some macros set up for no-one-fucking-wanted bloody boilerplate code that is omnipresent fucking EVERYWHERE.. **cough**
Steering back on what I want to rant about.
We with our team have one major problem with golang. There is no standard for docs in code...
Like, Fing legit. Everyone uses notation for closest to theirs heart language, so you get inconsistent-as-fuck notations for parameters / function descriptions.
We have functions that look like
//doSth does something
and also
// doSth
// @Summary does sth
// @Description does something but in more words
// @Param
and so on and so on
And trust me Im getting mild example.
Why this language does not have A F...ING (well defined, using proper definitions) STANDARD YET?
EDIT:
bonus context: We decided that too much of our code is undocumented and we go through efford of documenting it, but everyone sees it differently, and we can't agree on one single standard... So we decided to not refuse PRs due standard, as well, nobody would ever had PR accepted3 -
1/3rd of my work today was documenting my all the parts of my project that haven’t been documented and it felt good1
-
Have you ever gotten a task where you have to modify some existing code, and to get it to work the way it needs to you have to write some ugly ass code?
And I'm talking FUGLY ass code. The kind where every brain cell you have screams to refactor it all so that your code won't be so ugly and you can live with yourself. But you only wrote it that way because some numbnuts who was fired a year ago designed it that way, and left zero commentary or documentation on his reasoning ("sELf-dOcUmeNtiNg cOde, bRuH!").
It doesn't pose any sort of risk with regards to security or resource management or efficiency, or really even faulty logic. It just looks fucking awful, my brain can instantly see better ways to design it and I don't want history to tie my name to it.
But also the system is being gutted and retired within a matter of months, so maintenance won't even be a concern; and you know that you have a lot of other large tasks that need your attention too, and to refactor will ultimately prove to be a time sink.
I mean ultimately, I know what I need to do, but I guess it's a pride thing. Just makes me feel icky. -
I'm going to confess: I am the type of developer that creates the ExcruciatinglyLongAndSpecificClassNameObject with the UtterlyDetailedExplanationMethod. It's just a thing I keep doing, despite voiced frustrations from people I've worked with. It just feels right in the mindset of self-documenting code
And while I acknowledge this isn't a flawless process, I see no other way around without losing information. I've tried alternatives, but everything feels like trading one issue for another:
- Abbreviations work as long as they are well known (XML, HTML, ...). As soon as you add your own (even if they make sense in the business context) you can bet your ass someone is going to have no idea what you're talking about. Even remembering your own shit is difficult after X months.
- Removing redundant naming seems fine until it isn't redundant anymore (like when a feature with similar traits gets added). and you can bet your ass no-one is going to refactor the existing part to specify how it differs from the newly added stuff.
- Moving details to namespaces is IMO just moving the problem and pretending it doesn't exist. Also have had folks that just auto-include namespaces in VS without looking if they need the class from namespaceA or namespaceB and then proceed to complain why it doesn't compile.
So, since I am out of ideas, I'd like to ask you folks: Is it possible to reduce class/method name lengths without losing information? Or is self-documenting code just an ideal I'm trying too hard to achieve? Or are long names not a problem at all? I'm looking forward to your answers.19 -
I was asked to revisit some code yesterday - code that I had written at a much better time in my life. I was productive, I was on top of my project and we were delivering value to the organization.
I'm at a point now where I haven't written any code for months. I've been documenting and designing and arguing with teammates over inane shit. It's been an absolute slog, and I've started looking at what it would take for me to actually quit since I've got a kid on the way, and I've been bringing the stress and anxiety home from work. I've got so much money in options and salary, it's basically impossible for me to leave for better work.
I'd consider this the lowest point in my professional career. Four years of college - where I beat alcoholism and depression (mostly) only to end up at a place that I fucking hate, but cannot leave. It's affecting my family. I've drank more in the past 6 months than I have in my entire life.
And now I have to start repurposing old code to work on a new project that is fucked up 5 ways from Sunday. I honestly don't know how much further I can stretch my professional ethics to keep this shitload of cash flowing into my savings.3 -
It wasn't really the project itself, but more the execution of it
Last semester we were tasked with writing a new programming language from scratch. We were a team of six people, everything went great to begin with. We discussed language features, the framework runtime it should run on and even what language to write it in.
Fast forward two weeks, nobody is doing anything but me, the two dudes tasked with helping me were both no-shows and the others were busy documenting the syntax and semantics of the language.
I basically ended up having to write the whole language myself with no breaks no help and no guidance.
A few weeks before deadline I completely burned out and couldn't do anything other than just sit and stare at the code; mentally exhausted and not in a mood to do anything other than doing mindless unrelated tasks. But alas work had to get done.
And it did get done... Sorta.
Our beautiful statically typed, statically scoped concurrent programming language that was supposed to compile to BEAM code was neither statically typed, statically scoped, and the output ended up being half-working elixir code that only worked on the most specific of cases.
I don't want to work with those guys again.3 -
oh my goodness if I dhsfjhsjfhj
i can barely type right now im so frusterated
I've told my manager multiple times that I don't feel comfortable with the task hes trying to give me because it feels way too large (its designing/programming/testing/documenting an entire prototype cloud file sync application and server backend service on my own, replacing one we have had for several years) and he still just ignores me and persists that I should be thankful for the opportunity and challenge.
It pisses me off so much when people say dumb shit like, 'its a great opportunity to learn' at work. No it isn't. Your boss is going to be on your fucking case for taking too long or not delivering enough, and thats exactly what happened. He got upset and said he was expecting more things to have been written down by now, like design notes. I was just fuming. Design notes? I'm not even a freaking designer, I've never designed any type of big software ever, what the fuck do you want from me.
On top of that, I don't know where the hell he expects me to get time for this. I'm apparently also devops so I get yoinked off of anything im doing if some stupid thing breaks in some other environment about something I really don't even care about. Any other random ass task just gets dumped on me too. I'm supposed to be a 'junior developer', and get paid as such (i've wanted to go to the intermediate level but get told the title doesn't actually matter and no pay raise for you) but I get the responsibilties of a whole fucking team dumped on me and its just
do I just quit now? I'm just, for fuck sakes man4 -
Systems guy: this is how you slow down development projects. By tying design to a software development ticket.
Software guy: yeah but that's how you get reminded to do the work and tie a design requirement to the software development effort in the ticket.
Systems: why do I need to be reminded of my design work?
Me: because you're a year behind software and at this point you are just documenting what software has already done?
Sometimes I feel like the design guys don't understand that if they want to be involved in the process they need to NOT keep us waiting until right up against the deadline to give us the design. -
Sooo as of January of this year, I have a new boss, this dude basically acted as my “mentor” for the last year so he’s already tried micromanaging me but bc he wasn’t my boss, I could push back.
Long story short, he is now my manager, he’s the global marketing leader and I’m the marketing director for the Americas (been doing this role for two years) yet he treats me like I’m an idiot, in his words he wants to make sure I’m in control of my team before he lets me lead fully while simultaneously telling me that I need to step up and lead.
I politely asked him to let me lead and stop attending all my team meetings, stop delegating tasks to my team directly and instead consult w me so then I can delegate, and basically to respect the fact that clearly I’ve been successfully doing the job for the last two years.
He said no, that he won’t leave my meetings until he feels I have full control of my team, continues to over involve himself in all my projects, pulling my team in a bunch of directions w new projects and ideas left and right, and burning us all out.
To add insult to injury, he sent me a very “helpful” email detailing how I need to work better and faster and how he expects me and my team at full speed, my team is made up of me, two new hires that are a month old, my marketing manager, and I’m currently hiring for another team member. (This after he led a company restructure of my previous team that resulted in me losing 4 team members in December so I’m rebuilding my team).
I’m already overwhelmed and demotivated, pretty sure he wants me to quit and he has a proven history of bullying his staff, he was actually fired from our parent company for this exact reason a few years ago, he also happens to be European so not sure how rules work over there, but he was rehired by my company. My European colleagues hate him too, but they’re too scared to speak up.
I used to love my job and now i dread it, I drink every day after work and I get anxiety everytime he emails me which is at all hours if the day. Is it worth it documenting his bullshit for HR or should I just cut my losses snd leave?
Appreciate the advice!3 -
Helping out a team, I was documenting some code/processes when I came across several classes that was logging a lot of, IMO, 'junk' that was unnecessary (and I knew wasn't being used in any Splunk alerts/reports)
I offer a refactoring suggestion, simplifying the data being logged, moving the duplicate code to a central location, maybe saving 10~20 lines of code. Didn't think it was a big deal because they were already actively working on the code and it was all new code (nothing deployed to production yet). Sent the suggestion to the lead developer and he responds:
Dev: "Yes, the changes looks fine, but not in scope of the project. Any out of scope work will need to be suggested at the end of the project, reviewed by the team, the project manager and approved by the vice president."
"Out of scope"? Logging data to Splunk needs a vice president's approval? WTF?
YOU PROBABLY HAVE THE PROJECT OPEN IN VISUAL STUDIO RIGHT NOW!!!
Along with the documentation the lead dev said they didn't have time to do, I send his boss and the dev team my suggested changes (before-after screen shots of the code) and offered to do the 2 minutes worth of work (again, this was new code, nothing in production and zero side affects to anything).
I even offered to create the splunk reporting/alerting against the data being logged (another item they said they would not have time to do)
About a minute later the lead dev responds..
Dev: "Those changes look good. I'll have Jake make those changes and we can test the logging when we deploy to dev on Monday. Thanks!"
Of course you will...fracking ass hat.
I'll bet my Battlestar Galactica DVD box set he was going to make the changes himself, brag to his boss how he refactored the code, saving X lines of code..blah blah blah to help *me* with documenting the logging portion. -
Into a bunch of open source hogging meat heads because no one likes paying for things their own peers toil days and nights creating and creating more under documented over expensive licensed stuff (because agile) while throwing buzzwords to clients just make business while simultaneously choking the life out of underpaid overworked devs and engineers with the skill of running away from responsibility trying to save their own skin with the inept ability to look like a hero/King at the end of the day with a single mail sent with psychic communication or the lack thereof with people who are slogging their asses off to fix a problem created to the vulnerabilities and bugs introduced due to the impatience of the same moron who couldn't afford to give his employees/subordinates more time to figure out an elegant solution to a non existent problem created in the confusion of improperly documenting unnecessary requirements of an ignorant or unknowing client who is way too eager to process way too much load with way too less resources all the while whining about lack of features theyre not gonna use.3
-
All summer I've been working at a company doing some full-stack development. Starting my last year in university, I really wanted some real life experience that ties into my studies.
I did not expect to find horrible, undocumented, code that has been written 5 years ago, where the senior developer who wrote it doesn't even know what it does. The worst part? They are STILL not documenting! I tried to document, but got this in return "you don't have to document everything. Especially if it is understandable". But they don't even understand their old code!
Monday morning, we had a meeting and they asked what I thought of working here, seeing as I am done this week. I respectfully told them that their code is not readable, and it will make it hard for new employees to understand. The boss in return says "you're the third newly hired employee this summer to say this... Maybe we do have a problem then"..
No shit. Please for the love of God, comment your code!2 -
So I’m a huge fan of visual studio, but it let me down today.
“Find all references” just straight up fails to find all references of a member in this big F# solution I’m documenting.
I need to be able to reliably find what I’m looking for.
Reshaper for visual studio appears to not be that maintained for F#. FML.
Download Rider evaluation on the off chance, it works flawlessly.
One begrudging commercial license purchase later (despite being the only employee) and I now have software that actually fucking works.
What a wonderful time when Microsoft’s official IDE fails in analysis of its own language. -
Story of my first successful project
Being part of a great team, I've shared in a lot of successes, one I am particularly proud of is my first attempt to use agile methodologies in a deeply waterfall-managment culture.
Time was June/July-ish and we applied for a national quality award where one key element in the application stated how well we handled customer complaint resolution.
While somewhat true (our customer service is the top-shelf good stuff), we did not have a systematic process in resolving customer complaints. Long story short,
the VP lied on her section of the application. Then came the 'emergency', borderline panic meeting (several VPs, managers, etc) to develop a process to better manage
complaints before the in-house inspection in December.
As most top priority projects go, the dev manager allocated 3 developers, 2 DBAs, and any/all network admins we would need (plus all the bureaucratic management that wanted their thumb in the pie).
Fast forward to August, after many, many planning meetings, lost interest, new shiny bouncing balls, I was the only one left on the project. The VP runs into the dev manager in the hallway and asks "Is my program done yet? If its not ready before December with report-able data, we will not win the award."
The <bleep> hit the fan...dev manager comes by...
Frank: "How the application coming along? Almost done?"
Me:"No, haven't really started coding. You moved Jake and Tom over to James's team, Tina quit, and you've had me sidetracked helping other teams because the DBAs are too busy."
Frank: "So, it's excuses. You really think the national quality award auditors care about your excuses? The specification design document has been done for months. This is unacceptable."
Me: "The VP finished up her section yesterday and according to the process, we can't start coding until the document is signed off."
Frank: "Holy f<bleep>ing sh<bleep>t! No one told you *you* couldn't start. You know how to create tables and write code."
Me: "There is no specification to write to. The design document is all about how they plan on reporting the data, not how call agents will be using the application to serve customers."
Frank: "The f<bleep> it isn't. F<bleep>ing monkeys could code against that specification, I helped write it! NO MORE F<bleep>ING EXCUSES! This is your top priority from now on!"
I was 'cleared' to work directly with the call center manager and the VP to develop a fully integrated customer complaint management system before December (by-passing any of the waterfall processes that would get in the way).
I had heard about this 'agile' stuff, attended a few conference tracks on the subject, read the manifesto, and thought "I could do this.".
Over the next month, I had my own 'sprints' and 'scrums' with the manager (at the time, 'agile' was a dirty word so I had to be careful of my words and what info I shared) and by the 2nd iteration had a working prototype.
Feature here, feature there (documenting the 'whys' and 'whats' along the way), and by October, had a full deployed application.
Not thinking I would get a parade or anything, the dev manager came back from a meeting where the VP was showing off the new app to the other VPs (and how she didn't really 'lie' on the application)
Frank: "Everyone is pleased how well the project turned out, except one thing. Erin said you bothered him too much with too many questions."
Me: "Bothered? Did he really say that?"
Frank: "No, not directly, but he said you would stop by his office every day to show him your progress and if he needed you to change anything. You shouldn't have done that."
Me: "Erin really seemed to like the continuous feedback. What we have now is very different than what we started with."
Frank: "Yes, probably because you kept bothering him and not following the specification document. That is why we spend so much time up front in design is so we don't waste management's time, which is exactly what you did."
Me: "We beat the deadline by two months, so I don't think I wasted anyone's time. In fact, this is kind of a big win for us, right?"
Frank: "Not really. There was breakdown in the process. We need better focus on the process, not in these one-hit-wonders."
End the end, the company won the award (mgmt team got to meet the vice president, yes the #2 guy). I know I played a very small, somewhat insignificant role in that victory, I was extremely proud to be part of the team. -
Finished a validation library and knowing the common excuse for not using code already written (devs come down with 'not invented here' syndrome) is "I would have used it, if there was documentation". Spent this week documenting each class/method, diagrams, scenario based code examples, sent to my boss for review ...
Boss: "Wow...this is fantastic. All our libraries should have this level of documentation. You even updated the project's Nuget package to include a link to the documentation. Devs won't have an excuse now. I'll clear your plate for the rest of the year so you can get started."
What the hell did I just do to myself? FML.1 -
Writes good code because "Good code is it's own documentation"
Ends up documenting someone else's code. :( -
What are your thoughts on documenting developer (local/dev) functional testing? Should we be trusted that we've tested our shit and it works? Or should we provide proof? Are we better to provide proof to protect ourselves?3
-
Hello friends 😊
I just need to get this of my chest
But at my school we currently have this project where we need to create a webapp eventually which is nice. BUT first we NEED to spend a whole semester documenting stuff! I mean some things are necessary I know that! But a whole semester ffs I'm studying to be programmer so I WANT TO CODE STUFF
Why is my school like this 😩16 -
Working on complex invoicing systems. For once, the code is clear, elegant, readable and unit-tested... but I keep forgetting how reality works. If only tax laws were self-documenting.
-
I just spent 6 hours searching for the reason my code ONLY works when stepping through the breakpoints. Turns out I just had to add a single line of code to my procedure (chartObject.Activate) to make it work. I'd be lost without those 3 year old posts on some shady Excel VBA forums.
Thanks for documenting that, Microsoft! -
Had an awesome time coding a tool for work over the weekend. Now I'm writing the documentation and wish I was dead :'(
-
So we 3 devs working on a real estate system.... The guy who initially wrote the system wrote it in a fucked up state
Project structure was shit so we had a meeting and I suggested we restructure the project and also have some minimal documentation coz the system is growing we adding more features before current ones are finished
We agreed and started polishing up the system coz it seemed more features we wanted were now becoming more and more difficult to implement
So the other guy tells me to pull some updates.... To my surprise he had started documenting the system without restructuring first.... Had to quickly restructure the thing and push updates
How can 1 start documenting the very same design we want to abandon 🤦 -
has anyone here done a proper refactoring? i mean, documenting, following some rules, etc.
i need to know the process and guidelines for refactoring, what & how to document, where to start, etc.
i am assigned to a project for a short term and my job is to do refactoring of Reactjs code. and i need to do it in a really good way.
any help would be highly appreciated.
thank you.2 -
Dear open source tool authors,
DOCUMENT YOUR SHIT! YOU CANT RELEASR A BILLION VERSIONS OF IT AND STOP DOCUMENTING AT VERSION 1.4!
WHAT DOES THIS CALL DO???????? CAN I USE IT TO SOLVE MY PROBLEM? FFFFUUUUUUUUUUUUU!!!!!!!!!!!
P.S. Learn from Brett woolridge, creator of HikakiCP.6 -
I hate doc comments in Rust. They are literally just markdown without any special syntax for documenting stuff. What the actual fuck. Why can't everbody just straight up copy how javadoc does it 😭4
-
Time sheets. I'm not a fan of our task management system, you don't check out jobs or tasks like moving cards on a kanban board, it's more of a loose, calendar-based setup. We're also in a small, open office so it can be difficult to remember to log things in the software when you could tell the person opposite you that their task is finished. On top of that a lot of the time it takes me longer than the scheduled time to get a job finished as I'm learning a lot of new stuff, so digitally documenting things like that worry me a little. I don't want to look like I can't hack it just because a job takes me longer than my much-more-experienced colleagues.
I should note that I understand it's all incredibly useful data to the company, but I hate doing it and it's very easy to forget or ignore.4 -
So in my experience, coding while I'm not sober actually helps out sometimes. I always end up documenting my code way more so that I can keep track of what I am doing, and the code I write is actually decent.
Ofcourse, I always re-test it once sober again2 -
It's really painful to go through a codebase when the other guy doesn't comment anything. It's a new project, you have the opportunity to make it not a nightmare to work with, and yet you choose to not document shit. I've been documenting stuff as I go along at least. Feels like I should have some linter forcing comments on methods at least.
-
confessions[0]
I got into hell and sinned there.
This was a few years back when I was getting into webdeb. I was working with WordPress at that time and a start-up asked me to help them build a website on WordPress through a mutal friend. That was my first WP site and it is a jungle of unorganized code. I didn't bother making a child theme, overwrote PHP files without documenting it and changed CSS in the orginal files. Instead of a child theme, I made a monster.
The worst part is, that site has never seen an update coz an update in WordPress would undo all my work. I should prolly burn the server the site is hosted on to purge my sins. -
Was told at work today that I don’t follow directions closely enough and the lack of attention to detail in my work is a problem.
I remember being this way since my first elementary school teacher pointed it out to me. I’ve always been this way. It’s how my brain is wired. No matter how hard I try, I always miss something. Especially when it is a really complex set of tasks. I’ve literally got the results of a cognitive test I took in college documenting and quantifying my working memory deficits.
You think you’ll change that now, after more than four decades of me being like this, with a performance review? Good fucking luck!8 -
I’m currently working 2 jobs with over 60 hour work weeks in addition to my own SaaS company.
One job is full-time 40 hours, where I am a mid level developer and I just do the waterfall of tickets that is assigned to me. This place is unorganized and has almost no communication within the team.
The second job I am the Senior Dev and project lead. It’s a contract position that I put 20+ hours in on the evenings and weekends. Agile methodology, with a modern tech stack and I promote excellent communication as well as documenting everything.
I’m in a unique position because I’m able to see these differences and compare them side by side. My full-time job doesn’t really know about the second job. I get my work done, and that’s all that matters. This place is a mess. The project lead (CTO) is a helicopter boss that sticks his nose up at any type of formal documentation and practices. No tests are written.. no SIPs or deployment docs.. no stand ups or anything. I must also mention this team has 5 developers and a QA.. my team is only 2 developers and a QA. We get through tickets much faster.. it helps when I go over every single ticket that is created and add requirements and images..
I guess my point is... I’m about to be a full-time contractor because I can’t take this unprofessionalism anymore.
Just because these formalities technical take longer. It does decrease actual time spent developing a project. Spending a couple of hours on tests and requirements can save you days of back and forth in the future. Not to mention... document.. everything.1 -
Spent the day refactoring old copy-pasted astronomical code with minimal commentary, cryptic variable names and missing mathematical symbols. Self documenting code my ass.1
-
Documenting your code is like raising a child in a world full of idiots. If the parenting is not done right then your code will be as stupid as the world.
-
Having a lot of bad experiences while working as intern in startups and about to join a MNC, i wanted to share my work life balance and technical demands that i expect from a company. These are going to be my list of checkpoints that i look forward , let me know which of them are way too unrealistic. also add some of yours if i missed anything :
Work life balance demands ( As a fresher, i am just looking forward for 1a, 2a and 8, but as my experience and expertise grows, i am looking forward for all 10. Would i be right to expect them? ):
1a 8 hr/day. 1b 9h/day
2a 5days/week. 2b 6 days/week
3 work from home (if am not working on something that requires my office presence)
4 get out of office whenever i feel like i am done for the day
5 near to home/ office cab service
6 office food/gym service
7 mac book for working
8 2-4 paid leaves/month
9 paid overtime/work on a holiday
10.. visa sponsorship if outside india
Tech Demands (most of them would be gone when i am ready to loose my "fresher " tag, but during my time in internship, training i always wished if things happened this way):
1. I want to work as a fresher first, and fresher means a guy who will be doing more non tech works at first than going straight for code. For eg, if someone hires me in the app dev team, my first week task should be documenting the whole app code / piece of it and making the test cases, so that i can understand the environment/ the knowledge needed to work on it
2. Again before coding the real meaningful stuff for the main product, i feel i should be made to prepare for the libraries ,frameworks,etc used in the product. For eg if i don't know how a particular library ( say data binding) used in the app, i should be asked to make a mini project in 1-2 days using all the important aspects of data binding used in the project, to learn about it. The number of mini tasks and time to complete them should be given adequately , as it is only going to benefit the company once am proficient in that tech
3. Be specific in your tasks for the fresher. You don't want a half knowledgeable fresher/intern think on its own diverging from your main vision and coding it wrong. And the fresher is definitely not wrong for doing so , if you were vague on the first place.
4. most important. even when am saying am proficient , don't just take my word for it. FUCKIN REVIEW MY CODE!! Personally, I am a person who does a lot of testing on his code. Once i gave it to you, i believe that it has no possible issues and it would work in all possible cases. But if it isn't working then you should sit with me and we 2 should be looking, disccussing and debugging code, and not just me looking at the code repeatedly.
4. Don't be too hard on fresher for not doing it right. Sometimes the fresher might haven't researched so much , or you didn't told him the exact instructions but that doesn't mean you have the right to humiliate him or pressurize him
5. Let multiple people work on a same project. Sometimes its just not possible but whenever it is, as a senior one must let multiple freshers work on the same project. This gives a sense of mutual understanding and responsibility to them, they learn how to collaborate. Plus it reduces the burden/stress on a single guy and you will be eventually getting a better product faster
Am i wrong to demand those things? Would any company ever provide a learning and working environment the way i fantasize?3 -
When you document an entire infrastructure layout and your boss says, "ok.....let's analyze what you've done..."
1 -
1. Music, something fast paced with minimal to zero lyrics (usually a GOA radio station in my case)
2. No distractions around (use a "do-not-disturb" flag or something to hang on your monitor or show on your desk)
3. No chats or other communication/social media visible, best case those apps / tabs are completely closed or muted
4. Having a clear goal to achieve, might even be only a sub-goal for the current coding session.
5. Structure your code before your actually write it, I usually create step-by-step comments in each file, documenting my thought process and what steps the current file/class/whatever should do.
6. Try to code your stuff in the same order as the aforementioned comment step-by-step list dictates (unless there is a reason to change the coding order)
7. Only windows open: IDE/Editor, Browser
8. Also keep only the browser tabs needed for your work open (testing clients, documentation, music if using a browser client, etc.)
At least that's what works for me3 -
Am I the only one who loves documenting their work? I mean I just absolutely love making Github gists, man!
It helps in the backend-frontend integration and in communication between teams that is necessary for frictionless progress towards our common goal.6 -
Has it ever happened to you that you take a simple 6 hrs task, build it and then redesign to make it generic by wasting 30 hrs more and spend another 20 hrs documenting it so that others can use that generic feature?
1 -
Recently I've been tasked with setting up of a small /mid-size infrastructure and I've been documenting things like infrastructure design, network configuration all the way to playbooks and cluster configuration.
Since I just started with this, until now I have been doing this in a Google doc / some spread around markdown files. I would like to have a better way of having this documentation hosted internally..
I have been playing around with local installations of rtd, gitbook and mkdocs. So far, I've liked the simplicity and customizability of mkdocs.
Any other options before I commit myself to mkdocs?2 -
When documenting some stuff in Eclipse and you separate the parameters from the actual explanation with a - and hit ctrl+shift+f (refactoring) so the - goes to the next line along with the explanation... good thing I only documented 2 methods so far LoL they have like half a dozen parameters though o-o
I wanna thank the comment I just deleted for making me realize this LoL better now than when the whole interface is commented good jesus -
I just uploaded the first part of my first programming tutorial, and I want to make sure I’m headed in the right direction and I’m not being overly confusing. The tutorial is unfinished (I’ve really only written the very start) but I think early input would be beneficial.
Some context: LibLib is a library I make for Minecraft mod development, and I’m documenting the GUI framework in it.
http://teamwizardry.com/2017/11/...2 -
How many of you guys have an actual development life cycle at work (documenting every step, officially closing out of design, implementation, testing, etc)?
My place has a pretty stringent cycle. It is usually useful, but can occasionally just feel like paper pushing. It seems, though, that a lot of devs on here just sit down and start typing until someone says stop?4 -
4.5 months of being tech lead and I think I’ve had enough already and will just go back to being an individual contributor.
Once technical direction is set what remains is coordinating, organising, communicating, documenting. Zero tech’ing.
Turns out it’s dull as fuck most days.
😕 -
Coolest project.... SharePoint sucks, so I wrote an app to extend it into something that is useful.
The app consists of:
- a custom SharePoint event receiver to maintain a custom retention setup
- a custom feature to enable users to tag documents as related to each other
- a custom search experience with custom views and previews
- a .Net windows service to sync the data into a SQL database
- a .Net MVC application to manage the reporting and notifications system
- a notifications system in .Net
- custom SharePoint approval workflow
- a PHP site that maintains a full backup of every document in the event that SharePoint goes down
I was the only developer on the entire project and while I asked for backup they never provided it. So if anything happens to me... And since I am a good dev, my code is self documenting and someone will need to telepathically link to me to find out the multiple places that all of this is running (like five different servers including both windows and Linux).
The whole thing, I have about 18 months invested into it ;) -
Started documenting on how to use ＬａＴｅＸ ( MathJax ) in Ｍａｒｋｄｏｗｎ.
https://github.com/MarkedDown/Math
Let me know if you have a topic that you would like to be documented sooner than others~
Image shows an example usage
from a project I'm working on:
https://github.com/OpenlyEducated/...
-
Considering that Markdown exists and Readme files are rendered by default in GitLab, Github, and so on
Why devs insist on documenting stuff on Confluence?12 -
I requested an response from an Json api, the documenting and example showed perfect json as soon as I request it my self I get an array with Json in it.
What fucking logic is it to left your Json api with an array that contains the fucking Json took me way to long to debug that shit.1 -
Intelligent Development class (yeah, that's how it's titled), teacher leaves us as first task to develop our own Database, because later we will make it a fuzzy database.
She gave us three days. Three (counting me) in the team. I began working on Interfaces (Java development) and so on, using GitHub for VCS and documenting each method.
This assholes didn't even ask what was missing or what should they do. One day before date, I told them "Hey, I think I can nail the underlying file management tonight, so, work on the language parser, please"
Stood awake until 1 A.M., waiting for their reply, but there wasn't any.
Next day, I'm the only one of the team and I tried to decline the presentation of my work, but a friend encouraged me, because it was my work and I worked hard.
Presentation went better than expected.
After the class, I have another with one of my team members, he asks "How did you do?", "Us? You meant me, because the other prick didn't go".
And that's all, not another single question nor explaining why did he didn't answered the DM's I sent.
Fuck those guys, fucking team of shit, I hate it when you can't pick your team, but I guess that's just a common place for all of us here, isn't it?3 -
Damn you nginx...
Let's say you have a simple location directive like:
location / {
auth_reques /auth;
index index.html;
}
location = /auth {
internal;
proxy_pass <...>;
}
Now guess how often nginx makes a subrequest to /auth.
Thats correct TWO times... "why?" you ask?
Well isn't it obvious that nginx hits the auth request, then rewrites the request to the index file, hits the auth request again because it's technically a different request now and then proceeds to hand out the file?
Thanks for documenting this. NOT6 -
It sucks when you are unable to work on any new features in forever and mainly spend time updating the existing code base, doing visual designs & documenting the application.
Let me please work on a new feature that the clients will use instead of meaningless busy work2 -
Yesterday’s dev achievement. Created a docsify project so that the rest of the company can start documenting their shot.
Something I had implemented in my team a while back, first thing this morning I get a message from the CTO to add mermaid support for his architectural graphs for his latest project.
Tomorrow’s dev achievement, 0 lines of code will be written after 9am. -
I want to start learning to document my code. What tools do you guys use? I've seen https://www.gitbook.com/ but their server has been on and off all day and I prefer reliable services.
This project is the reason I'm finally learning to document my code: https://gitlab.com/datwood/...1 -
!rant
So, I wanted a little suggestion here.
I'm currently interning at a startup and currently we document our build procedures by creating .docx files containing the steps. But docx is a pain in the ass. I'd rather prefer markdown for documentation.
Are there any better tools for documenting? What do you guys use?
We're using Jira for project management bdw.1 -
Writing javadocs for interfaces with quite complicated methods all day is so fucking exhausting. Programming itself is so much easier than documenting the written code clearly and precicely so that everyone understands it.
Top Tags
Weekly Rant
View