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
-
Every fkn 3 to 4 days, some random dev shows up in my office really really fkn confused and frustrated about something he doesn't understand - because I have a dark secret.
Sometime, in cold lonely nights, when no one is watching, I write my documentation before the actual code.
Somehow, sometimes documentation without code attached to it makes it to production.
Today someone yelled at me for wasting his time because he wasted 3 hours trying to find the code the documentation belongs to - and demented I stop the practice from now on.
Agh.13 -
Once Ashish was travelling by train in A/c class. He was traveling from Mumbai to Bangalore!
He was traveling alone!
Some time later, a Beautiful lady came and sat in the opposite berth!
Ashish was pleasantly Happy!
The lady kept smiling at him! This made Ashish even more Happy!
Then she went and sat next to him!
Ashish was bubbling with Joy!
She then leant towards him and whispered in his ear " Hand over all your valuables, cash, cards, mobile phone to me
else I will shout and tell everybody that you are harassing and misbehaving with me"
Ashish stared blankly at her!
He took out a paper and a pen from his bag and wrote " I can not hear or speak. You write on this paper whatever you want to say"
The lady wrote everything what she said earlier and gave it to him!
Ashish took her note, kept it in his pocket!
He got up and told her in clear tones..."Now shout & scream!!"
MORAL OF THE STORY : *DOCUMENTATION IS VERY IMPORTANT*
😄😀😄4 -
Documentation is like sex.
When it's good, it's very good.
When it's bad, it's better than nothing.22 -
##Real fuckening STORY##
Angry client: this feature is not working like we discussed !
Me: it is.. *giving some explanation*
Client : no, this is not the right way
Me: But this is what we documented while gathering requirements, and YOU signed in the documentation..
Client : that long document? you don't expect me to read all of that talk just for this simple feature..
Me inside: *killing him 5 times in 5 different ways13 -
To write 1000 lines of JS, I need 1 cup of coffee.
To write 100 lines of documentation I need 100 cups of coffee.
For some reason time stops when I open confluence9 -
I find it super annoying, this trend where no one wants to write learning documentation anymore, but instead put up a bunch of demo videos and video "training courses."
I don't want to spend 5 minutes watching you do something that would take me 10 seconds to read. I can't search for terms in your video, and I can't use them as a general reference manual. I can't go at my own pace, easily keep my place between devices, enter code as you go, the list of cons goes on and on.
I would rather pay you money for a good eBook (and no, PDFs don't count), than to have the only realistic way to learn about your software be a playlist on your YouTube channel.
This, however, this...
Went to check out Ansible again, because I've heard good things lately and it's been a couple years since I've looked at it.
Took me a while to find their docs because there's almost no mention of anything on the home page except trying Tower for free.
Found the docs. The first item there is the Quick Start Video and I think, "Cool. That's a good use of video, showing off the product."
I dig out some headphones, click play:
"Ansible is a powerful" BOOM!
Enter my email to watch the video?!
Ah, forget it. Maybe I'll see you next time, Ansible.
8 -
“Our code is our documentation - it’s produced in such a way as to be explanatory, logical and clear, and annotated if/where needed”
Really?? That's the reply you give me when I asking API documentation for handover ?5 -
Documentation is like sex... When it's good, it's very good. When it's bad, it's better than nothing.4
-
Worked 8 hours on a feature to send attachments from our system (A) to another (B) via B's API. Perfect code, yet I couldn't make it work. B's API has full and extensive documentation for said feature. Contacted B to ask about it, got reply: "Oh yeah - we havent enabled that yet but thought it was handy to have it ready in the docs"
FML
4 -
Once IT Engineer was travelling by train in A/c class.
He was traveling alone!
Some time later, a Beautiful lady came and sat in the opposite berth!
IT Engineer was pleasantly Happy!
The lady kept smiling at him! This made IT Engineer even more Happy!
Then she went and sat next to him!
IT Engineer was bubbling with Joy!
She then leant towards him and whispered in his ear " Hand over all your valuables, cash, cards, mobile phone to me
else I will shout and tell everybody that you are harassing and misbehaving with me"
IT Engineer stared blankly at her!
He took out a paper and a pen from his bag and wrote " I can not hear or speak. You write on this paper whatever you want to say"
The lady wrote everything what she said earlier and gave it to him!
IT Engineer took her note, kept it in his pocket!
He got up and told her in clear tones..."Now shout & scream!!"
MORAL OF THE STORY : DOCUMENTATION IS VERY IMPORTANT
😄😀😄4 -
Day 2 of writing documentation: still ready to go insane from repeating myself and am reconsidering everything I have ever done in my life...
8 -
FUCKING TELEGRAM FUCK YOU STAY IN YOUR FUCKING API DOCUMENTATION AND STOP FUCKING TESTING YOUR SHIT ON A PRODUCTION SYSTEM WHY WOULD YOU DO THAT FUCK OFF WHY AM I EVEN DEVELOPING SHIT FOR YOUR PLATFORM ANYMORE WHEN FOLLOWING YOUR DOCUMENTATION LEADS TO FUCKING ERRORS AND WE HAVE TO DECOMPILE AND REVERSE ENGINEER YOUR FUCKING "OPEN SOURCE" APPS BECAUSE YOU DONT EVEN BOTHER TO FUCKING UPDATE THE SOURCE CODE ONCE A YEAR WHAT THE FUCK
Thank you for your attention7 -
Now don't get me wrong, I love the multicultural aspect of open source coding.
But for the love of everything that that is sane, please do not write the basic readme and code in English, and then write the entire documentation for the code in another language.
(Yay first rant)
7 -
Uh, I gotta do Task #1337. It better is a good one!
*reads the title*
"Write technical documentation for... "
... D'oh! -
That moment when you search for Microsoft documentation and realize there is none, so you go search for source code and realize there isn't any of that either. 😑5
-
I am sure this has happened to all of us in some extent with some variations.
Colleague not writing comments on code.
Ask him something like "How am I suppose understand that piece of garbage you have written when there is no comments or documentation?"
This keeps happening for a long time. Some time after, I write a kernel module using idiomatic C and ASM blocks for optimizations (for some RTOS) and purposely not write neither documentation nor comments.
When he asked for an explanation, I answered to everything he questioned as general as I could for "that trivial piece of code".
After that he always documents his code!
Win! 🏆4 -
People should fucking document their code. I have to implement something using someone's code. And I have no idea what I'm doing.6
-
Ironically, the face I make when a project has no documentation is the same one I make when someone asks me to write documentation.
1 -
I dunno if anyone else has said this here but
FUCK WORDPRESS DOT COM
FUCK WORDPRESS DOT ORG
FUCK WORDPRESS PLUGINS
FUCK THEIR DOCUMENTATION15 -
Stupid apple documentation. can't even give a damn example. I have to go to Microsoft documention to get example on a framework made by apple. What a joke.1
-
🤘 😈😈😹 🤘
Wordpress documentation...
"
Hi all, 😎 welcome to wordpress.
Use it as your last resort. Fuck all programming langs. Php is love, php is life."
Oh by the way documentation also says:
"
Wordpress gives you all the freedom you can imagine. Say for instance... You can use any language for server EXCEPT python, ruby, java, c# and many more.[note: Keep looking for the updated list of EXCEPT as new languages come we add it here.]
"
😂😂😂2 -
This is one of my favorite lines of documentation 😁
Found in the description of flags for SVN commands: http://svnbook.red-bean.com/en/1.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 -
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
-
"Oh, documentation? We don't write documentation. Our tests are our documentation."
Sure - I guess your developers are computers, too.6 -
I have now worked on integrating Stripe, Razorpay and PayPal on our app.
While Stripe has an absolute gem of a documentation.
Reading PayPal's documentation has been one of the most torturous week of my dev life.3 -
- I am leaving the company, so you will work on my project.
- (looks at code) But there is no single doc string or any documentation apart from the installation guide.
- Yes, but the project is really easy to understand.
... I will just sit here trying to understand your code instead of doing actual work. -
I am using this SDK and I came across a property "Orientation" of type int.
Why int? Is it an enum or something? Let's have a look into the online documentation...
"Gets or sets the orientation."
😣
Yeah, thanks. Very useful.
It's again that kind of documentation which simply restates the property name or method name. Who needs this?
So I tried to set the Orientation property to 1 to see what happens.
A runtime exception then told me that the only valid values are 0, 90, 180 and 270.
Well, this is kind of stupid but ok, I can live with that.
But ffs, put that info into the documentation, where it belongs!
4 -
You know that Elixir takes documentation very serious when you only have around 120 lines on a Module and 110 are from documentation.3
-
Django was the first web framework I learned. I didnt understood the praises for its documentation ... Until I started using Flask...4
-
So both my and my friends documentation for this project got rejected. It wasn't much of a surprise as we both have the same teacher who is very very strict on documentation. We are discussing all the documentation stuffs when he drops this:
Going to Africa and giving all children water is easier than getting this fucking documentation approved.
I fucking lost it xD. Okay, a bit harsh maybe but at least you get the idea.3 -
Email chains, screenshots shared in google docs, two comments per 1k lines of code, and sticky notes are sufficient documentation, right? RIGHT?2
-
Anyone else make the weirdest workarounds ever to trivial framework problems. Then read documentation to find out that there was a function for that...
-
Reading the Facebook PHP SDK documentation today to make a custom feed on a site. The documentation tells you how to do absolutely everything. Which is great in theory, but means you have loads to read to find the small bit you need.
Turns out I didn't need the SDK after all. Used simple curl request instead. -
I want to get in the habit of proper documentation of my code, But i'm not sure how it's formatted, how it should look or how I should even begin writing documentation? Do I open a document and just take snap shots of my code and explain how it works? I'm a little confused. Do I take pictures of my UI and explain how to use it? Is it like writing a book?
5 -
I'm absolutely fed up with all documentation being tutorial-based these days! Well written documentation doesn't start with you creating a new project from scratch.
This is basically how all of Microsoft's documentation starts: Step 1 - Open Visual Studio. Step 2 - Create a new project...
I just checked out their WPF samples repository, and about 8 of the projects won't even compile. Absolutely ridiculous. There's 205 projects in the repository, and of course the one I need is on the list of those that won't compile.1 -
!$rant
"Always make sure to have good documentation in your code."
And I still struggle with this advice xD -
IF ONLY DOCUMENTATION WAS IN ENGLISH
In the past I've seen documentation that is great, and documentation that is conspicuous by it's absence.
Over the last decade, I've noticed documentation is getting WORSE.
I believe the reason for this is that those tasked with creating documentation have become so accustomed to the jargon in their own heads that they have LOST THE ABILITY TO COMMUNICATE IN ENGLISH, and as a consequence simply don't bother.
New terms such as "ThingamyJig" are defined as "A Collection of ThingamyJigs" — so you end up going round in circles and get back to square one.
They make little or no effort to provide simple examples.
If only companies who create languages understood that those who wrote the language may not be the best people to write the documentation.3 -
Hate it when I spend more time on documentation than actual coding. I know documentation is for our own good. It still annoys me to death.6
-
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 -
I like reading documentation.
BUT I really hate writing one for a project that I have nothing to do with it.
I am charged to write a documentation just because they think I am good on expressing and structuring ideas.
F_M_L3 -
Why do some developers write the official documentation with low interpretability and a high number of technical terms? It does not look cool if it does not serve the purpose it was made for - Helping us understand your software!!!
-
project launched and everything is going smoothly so far. since I have some time, I started writing documentation and I put this at the start of the document.
4 -
I had this a while ago. Started a new project at my study (Application Development) and started working on the documentation. After rewriting parts of the documents for nine weeks (10 weeks for every project where I study) because they were not approved by my teacher because they didn't fit her 'personal preference/style', she even had the guts to tell me that I am a bad programmer because the application was even less than half complete. She only gave me one week to create the application that normally takes at least five weeks.5
-
Is it so hard to comment your code?
I work on collab projects here and there and both the comments and documentation are both awful, nearly always, there are some exceptions.
This is a plea to all those who teach anyone to program. "This performs a loop" is not a helpful comment, nor is "This sets variable x to 1" where the line below is "let x = 1".
The last piece of code brings me on to my next point meaningful variable names. If x is a variable that stores the age of a machine call it ageOfMachine or age_of_machine. Not aom, not x but what it actually is, modern IDEs and text editors will fill this out for you.
Finally documentation, a good friend of mine sent me this quote a while back, I can't find the image but "Documentation is like sex, when it's good, it's great. But when it's bad it's better than nothing." Your documentation should be good, a good pattern to follow is the Node.js documentation, it tells the function, what it does and what parameters it takes.
Anyway rant over; and I'm sure that this applies to people outside of this community only.5 -
I'm a python fanboy, not gonna lie.
I love everything about it. It's clean syntax, ready to use out of the box-ness, convenient built-in functions.
The one thing I hate is the official documentation. It's ugly, hard to navigate and a cluster fuck.
But it has proper information, so it's fine I guess. tsch14 -
Dear providers of SDKs, when you claim to have a full documentation for your SDK, please at least provide the info about what unit (radians or degrees) the Angle properties are. Especially important when the iOS SDK is taking radians and the Android SDK is taking degrees, as I found out by experimenting. I don't even care so much about float on Android and double on iOS. Just make use of the fucking documentation and provide some actually useful info there. "Sets or gets the angle" is fucking NOT useful.4
-
Is making documentation in markdown recommended or word/other editor?
I also need to put some pics and codes.2 -
So I handed in my official resignation last week as I will be changing to a new job next month. So one of the last big things that I have been working on is a Jenkins server for the rest of the team to use and currently writing up the documentation for it.
However I haven't been told who I will be handing over my work to, but the bigger thing I feel is that even if I write all the documentation, no one will actually read it. Reason I think this is because I doubt anyone else in the team will even use the Jenkins server. The major issues are that no one writes unit tests and don't even understand what CI is!
So right now it feels like my final month of work will all be for nothing and makes me wonder if I should even bother writing documentation, especially if it isn't going to be handed over to anyone.5 -
My boss asked me two days ago to fix some errors in an application. From the errors I saw it would be a 5 minute fix. I fixed the problems just now because there was no documentation on how to set it up.
After setting it up it was just changing a value from true to false...
I ruined two days just because there was no documentation. Please everyone, I know writing documentation is boring but at least write some documentation on how to setup a project.3 -
Our documentation is currently stored in a VM image after the host died, meaning we have no access to anything - good times!5
-
could never figure out how to configure ssl because of google clouds insanely complicated documentation.
today i found a digital ocean guide that explains its a simple installation of certbot, run it once and set it to auto renew....
fuck you google5 -
Recently I had to work on a project using PrestaShop. Naturally I looked up the "docs" and found the part where they recommend to write documentation.
Fine until you realize they don't and the documentation website gives generic useless informations...
-
Sometimes I think the only thing worse than undocumented code, is poorly documented code; I mean seriously, you're just teasing me at that point.2
-
While I was still in University I didn't valued much the importance of comments and documentation, mostly because my projects were small and I was working on them by myself. Frankly, writing comments felt like a waste of time those days.
Now that I'm a junior developer working with an existing code base and together with other devs I couldn't be more grateful seeing those green lines of human readable strings. Without them I would have struggled more and probably been less productive.1 -
My deparment manager said to me that I'm the first person he encountered that has a fetish for writing documentation.
In the context of the conversation I felt he was mocking me, that he doesn't understand why its important, and I why feel obligated to do it (everything was a mess when I joined the team 2 years ago).3 -
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
-
Am I the only one who does not like to use the Internal tools of company? In my company they have almost everything made by themselves.
I do not see any benefit for my skills, and above this the documentation sucks.9 -
Work is requiring me to bust my ass, I am salaried, it is writing documentation, and my FUCKING LEFT EARBUD DIED!3
-
"We have a nice documentation you can use to get this up and running"
>half the bloody variables used in said documentation are never even mentioned how they are defined
Nice. -
Every time I read some code of the rust standard libraries or code of other popular rust crates, I feel ashamed of the code I produce ... their level of documentation is just outstanding, mine is ... hardly existing?
Guess a rant about myself :D -
When you click on the github wiki of the API you wanted to use and it shows you the "Create the first page" banner....
Guess I'll have to find another API with proper fucking documentation.2 -
PM: "Can you take a look at this app and see if you can find why it's producing errors and fix it"
Me: "Yea sure, can I see the documentation so I might be able to understand the system and why it's doing that?"
PM: "There's no documentation" ... "Also it was cowboy coded by an intern" -
I started creating a complete API documentation for devRant. What do you guys think?
It's far from finished yet, but I'm heavily developing it right now.
Here's the repository: https://github.com/ThePlatzhalter/...
A preview is available at https://htmlpreview.github.io//...30 -
You want to know what shit is?
Go use Alibaba cloud service!
Trying out the service and luckily for me i only paid a few bucks.
-- Poor documentation which seems like it was written by the team from sales.
-- Poor github code samples... If i had written similar code while in college, it would be far better than their code samples... no exaggeration, It literally has 0.1% comment.
See for yourself
https://github.com/aliyun/...
-- Its Object Storage (OSS) C# APIs are all synchronous (Who fucking wrote this piece of shit deserves 10,000 punch in the face). You just killed the whole essence of netcore with oss.
-- Error logs are in Chinese (This was expected but seriously Ali you sold your product in English. WTF you got no English dev)
Coming from an Azure world, i would say Alibaba cloud is still in its infant stage (Cheap to use and Expensive to manage).
Make use of it at your own risk!3 -
Dear Java library developers. The javadoc is not an excuse to not write documentation.
Signed,
a very annoyed golang developer -
I have suddenly started liking writing word documents rather than writing code ...
What’s happening ??!? What’s wrong with me !?!5 -
The best kinds of comments:
/**
Gets user CC info datas.
*/
public Object getUserCCInfoDatas() {}
If you really want to outdo yourself:
/**
Gets user CC info datas.
@param someshit Outdated docs ftw
*/
public Object getUserCCInfoDatas(String unrelatedToDocAbove) {}
Honestly, no documentation is better in some cases. At least I can't be angry about their shitty quality... And they don't waste my time.3 -
I've seen several rants on here about poor documentation on great libraries. Well I just spent 9 hours in a car today and I realized that even the ones that have great documentation absolutely SUCK at being mobile friendly. I'm no web developer but how freaking hard is it to optimize your stupid website for small screens??? There are a million frameworks out there you can choose from PLUS it's almost entirely text so it can't be that hard!! I have to zoom in about 300% to be able to read it, then I have to scroll back and forth because it no longer fits on the screen.
-
!rant
A snippet from the official W3C service worker documentation:
"This avoids the problem of two versions of a site running at the same time, in different tabs. Our current strategy for this is “cross fingers, hope it doesn’t happen”."
https://github.com/w3c/...1 -
Team Leader(TL): So you finished the sql scripts and stored procedures?
Me: Yep!
TL: And properly formatting the front end to look exactly how we want it.
Me: Yep
TL: Well we waiting on feedback from the boss so i guess you'll have to do the documentation.
Me: I hate documentation, please give me anything else
TL: It's not a lot dude, you can do it.
Me: Didn't one of the intern's and the database admin do it already?
TL: Yes. but you can take both of them and make one complete one.
Me: *You just don't want me to work on my own things you FUCKER* Fine, but don't expect it to be done this week.
TL: It's Tuesday, why not.
Me: Because i hate dcumentation
I FUCKEN. hate! documentation.4 -
I fckin love it when you start working on a new project in a new team and the 5000 lines of Angular code are acompanied by 0 documentation.
-
When a function that sends an email to recover the password get's this summary I'm lost for words regarding documentation 😂
9 -
You know what pisses me off? When I don't know what a constant is used for so I check the documentation and this is what I see:
2 -
Taking over development of a system from some other guy who just straight up dropped it with zero documentation. The code looks like he wrote it after watching some getting started tutorial. There is no structure. Some methods and statements are just empty. And he spelt 'connection' three different ways in the same file.
God help me...1 -
When reading the documentation could have saved you hours of debugging.
"How nice, there's actually a property for that..." -
WooCommerce is shit
Just try to find anything in the documentation on their retarded website and you will get what I am talking about.
A billion of unstructured links. With absolutely no sidebar or table of contents.
IMPOSSIBLE to find any fuck there.
It is far easier to build an e-store from scratch, than to customize their ugly monster.
Now look Laravel or PHPunit documentation to compare how it should be.
-
Got into the job a week ago, was asked to do a documentation of a project. It started 4 years ago.4
-
An example of bad documentation? Unity. It has a list of poorly described methods of deprecated classes. The only reasonable documentation is the community. Docommunitation.10
-
Do you recommend Vue Press for documentation? Or do you know a good alternative?
https://vuepress.vuejs.org/2 -
If you're not going to update your API documentation please just delete it. I spent two hours trying to use the example only to discover SECRET REST PARAMETERS that solved my problem.
If it weren't for the hero bitching in the comments about the missing documentation I would never have gotten this to work.2 -
A software is as good as its documentation... a crap documentation makes it un usable... how so ever good your software is...
-
Google documentation sucks!
Lack of practical examples. They show us very simple example like clicking on button and then straight away redirect to API docs.
Wait, let me at least understand how things fit in together.
Me: Hey google where is step by step guide, at least for setup?
Google: We don't do that here!7 -
No documentation, even if it's for personal private projects.
I still can't wrap my head around code I made 2 years ago...1 -
As long as there's good documentation, and is relatively speedy, I really don't give a fuck what language/tech I'm using.5
-
Yet another Hacktoberfest tshirt
From Auth0
Received by improving documentation and the product itself
(The tshirt is darker than the image)
3 -
Question to the Java developers here:
Is it always the case that Oracles documentation and actual implementation don't match?3 -
Last year I wrote a sudoku program which did solve easy sudokus but messed up on harder ones. I had got bored after a bit and forgot about it until today I thought I'd rewrite it using new stuff I've learned since and make it work properly.
So I opened it up and look and I'm like 'WHAT!?' because I don't understand what I wrote. After a bit I start to get the idea and see that it was kind of smart even if long and complicated.
If anything, it shows how much my documentation skills have improved.
Now I just have to work out how to redo it in a way I understand.7 -
I need counseling to fix the distrust in my life.
Distrust of official documentation.
Why can't I trust it works the way they claim? The pain it causes...2 -
The documentation for the matplotlib python library is terrible for newbies.
There is a "Tutorial" section, but the thing doesn't even explain what you can do until you get to the 4th section!
It starts off with some confusing examples, how to change the appearance and only at section 4 do you actually start to get an introduction to the different components you might want to use...
At some point you finally realize, most of the stuff that is shown can be omitted because the .pyplot module is all you need. -
Guys, seriously, i dying from writing documentation. I'm frustrated and bored to the hell. But i need it for others. How to keep my mind fresh and excited? Just looking inside Leximo and see how much i need to write. https://repository.cartio.dev/lexim...
I need a coffee.
16 -
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 -
Official documentation > StackOverflow.
StackOverflow sometimes has well-grounded and elaborate explanations on a question by well-meaning and knowledgeable developers, but oftentimes the answers also contain outdated or 'dirty' solutions and so it's always to be taken with a grain of salt.
However, in cases like the official Spring documentation, the IETF RFC's and the MDN, those provide a correct explanation to the problem, even if it requires some reading around. When it comes to serious and correct work, I favor these over the bro-zone that is StackOverflow.6 -
At work we use "Mythological Documentation": mystical features and obscure workarounds are verbally explained across generations of developers that come and go, keepping the knowledge alive.
-
Don’t write documentation for other people, write it for yourself! It may all seem obvious today, but six weeks from now you’re not going to remember what you were thinking or why you wrote the code the way you did.2
-
Just switched to the "!" for Python Struct because it was a better description. Then i saw the documentation on this. A "little" bit offensive.. 😁
-
I asked at an interview if they documented their code with class diagrams.
One of the interviewers told me: "Good code doesn't need a class diagram"
...
*TRIGGERED*6 -
Dear developer guy who wrote this documentation node!
You're a developer yourself. Don't you know that inverse psychology is something you should avoid, because it will not work?
Thanks!
---
Okay for real, why shouldn't one parse Build.FINGERPRINT on Android? I was looking for a way to determine if the device is an emulator or not, and came across a solution using this, and read the documentation.
3 -
That feeling when you open link that's supposed to lead to the index of documentation and you find this...
The rest was.. unfinished..
#fml
-
When you join a project that has no testing, no component policy, a lot of css mixins, that has to work simultaneously as a pwa, android and ios app.
Oh, yes, obviously no documentation at all *flips table*3 -
If you have any project (personal or not, doesn't matter) that does not have proper code comments and documentation and you don't want to make one because of the effort (maybe even "wasted" effort), think again. When commenting on a wall of code to say what it does, you may find a better way of doing what you have to do, possibly increasing performance, or improving security.
I have been able to do better input sanitization for a method on a personal project of mine because of this.
Don't use the amount of effort for proper documentation as an excuse not to make one.2 -
When online documentation is nonexistent but everyone expects you to use the technology.
Well alright then!
2 -
Feeling sleepy reading v4l2 documentation.
Opens devrant for a few minutes.
After 45 minutes of scrolling and commenting.
Shit, I need to get the driver working today.1 -
Started a new contract:
Dev: "here, take this draft document containing a rough explanation of the requirements and write this service that exchange messages with these two subsystems"
Me 😐"ok"
-- couple weeks later --
Dev: "oh btw, you should go through ALL the fields in those messages described in the 'documentation' and double check them because we use millimeters and they use meters, we measure milliseconds and they use seconds. You should handle conversions when you deal with those messages"
Me (in my mind): "fucking son of a bitch! Why didn't you tell me this little piece of information at the beginning so I could have accounted for that instead of bloating the code now with your spaghetti style, full of horrible hacks, ifs and workarounds?
Me 😐: "sure, I will"
(don't worry, in the end I managed to find a clean solution for that 😉) -
Loving inaccurate documentation...
And it's from a big company as well!
Reset value: 0x0000007F
I didn't get it to work for several hours.
And then I checked...
The actual value it gets reset to is 0.
Just 0. -
One of the senior devs just showed me their documentation AND IT'S A FUCKING ONENOTE FILE WHERE EVERYBODY JUST WROTE WHATEVER THEY THOUGHT SHOULD BE WRITTEN DOWN IN RANDOM PLACES
Atleast it's some sort of documentation I guess.2 -
Googling for Angular (>=2) documentation and finding AngularJS instead feels like cancer.
If Google was going to "update" to what is functionally a new framework, they should've named it differently instead of trying to piggyback on the popularity of AngularJS. Sure, there's similarities, but let's be realistic here.7 -
Let's see what's on the menu today:
* Web Application Catastrophe Special *
Includes, but not limited to:
- Orphaned server processes in the configuration management cluster
- Microservice back-end architecture with no API documentation
- Poorly implemented cache microservice with no documentation
- Stale data causing everything to be shown as down in production, despite everything running fine
Cost: 1 developer's sanity -
I love this documentation about System. nanoTime()
Differences in successive calls that span greater than approximately 292 years (2^63 nanoseconds) will not correctly compute elapsed time due to numerical overflow.
Can I confidently say that no service will ever break this limit?5 -
no matter how many books i read about a particular technology, if i don't read the official documentation ( no matter how large it might be ) of that technology, i always feel dumb and stupid
-
Anyone in here have experience with UML in the real entreprise world?
As a student I've learned a lot about documentation and software architectural design, I've worked 3 different places and worked with customers that were developers and all of them seemed to not really do architecture and documentation that well. Personally I find having an overview/guideline for bigger project really helpful
how come you don't see better software documentation and UML out there?
Maybe I just haven't found the right place yet2 -
Love writing comments, hate writing documentation.
Ugh, I know it is needed but just don't care about it as much as the code/comments which is a more direct 'here is what this does' approach. Writing idiot proof documentation sucks. Any little change? Have to remember to update the docs. Yeah, not happy.1 -
Fucking hell the AWS IAM documentation is confusing as fuck. Trying to set up a fucking role is harder than cutting a rock with a fucking spoon.
And who the fuck thought it would be a good idea to allow a CLI user to run any command he's allowed to without any form of authentication??
Oh, set up MFA for the CLI you say? Good fucking luck with that, if you ever manage to figure out how to set that shit up!
Fuck this shit!3 -
It's so frustrating when libraries just give you a hello world example and you have to figure out what the fuck it does. No comments, no nothing. Then you go read the documentation, and find out they have topics for everything, but nothing explaining how it all comes together. They give you a hello world and then you have to figure out how the damn thing works.
Now I have to watch YouTube tutorials which will probably all use fucking Spring Boot and extra libraries. I just wanted a barebones example, is that too fucking hard?
EDIT: maybe I should take a break from this thing -
Documentation at the end of a 3 year project is like writing a blurb with only titles of the chapters... You better understand the entire project !! Good luck to the new guy.. Lol
-
I actually like writing documentation. It gives me a break in a different pace, gives me time to refocus on what I've built and hopefully make it useful for others as well.2
-
Starting a new side project and I am determined to do it right.
Just finished writing the features list and now I'm writing the documentation. Not written a single line of code not, nor even created a repository.12 -
I have become the only thing I always hated in a developer. Building a project without a proper documentation.
As a solo developer in a company where I have to do database architecture, front-end, back-end, testing, NETWORKING (I am the most ignorant guy when it comes to networking), product design, there is no time for documentation.
But hey, I have structured the project, files and functions (with comment, parameters type and return type) properly and I understand what I've done even after 4-5 months without touching that specific project so I got that going for me which is nice... I guess.3 -
Don't you love it when a network library is advertised as easy to use and quick to set up but the lack of proper documentation escalates the issue to a weekend long adventure about finding out how to do shit?
The Github wiki is full of small use case examples but none explain how to use the lib from ground up and everything is handled by an UI-based helper scene which you can't use anyways since the whole thing is supposed to run headless.7 -
Wow, I feel like idiot.
I struggled making documentation becouse I didn't know proper tools.
I sometimes used markdown but it was for internal git pages when I did, other times I just was doing crap within html (and I hate frontend and Dubba cannot frontend and its generally bad idea to give me html)
Than I had random talk with someone on the internet and he was suprised I never used (and known) markdown to html and I was more like "thats genius, why the fuck I didnt know its a thing".
goddamint...3 -
Reading documentation for 3rd party software... come across a code snippet which references a class. The class is spelt correctly in the comment but wrong in the code!
What??? Surely if you're going to get it wrong it would be the other way round :/ -
So on the weekend I picked up a project again I started 6-8 month ago. Due to automated scripts and documentation I could reach the point where I left of month before in a few hours. It's nice when writing docs and scripts pays off :-D
-
Just spent the last hour working out how something worked because I didn't write any documentation and it was a hack in the first place. Damn You Past Me!3
-
Just like there are many programming courses, bootcamps etc. there should also include documentation bootcamps and courses1
-
Treat documentation as first class folks. DOCUMENTATION is important. And yes, code does does replace a good documentation. Code and documentation are not mutually exclusive.4
-
yet another rant about shitty documentation, this one isn't readable without copying it out somewhere else.
How does someone decide this is good enough to post online, i swear some people don't proof-read anything anymore
1 -
Writes good code because "Good code is it's own documentation"
Ends up documenting someone else's code. :( -
Is it me or most developers just write code so it compiles and passes tests?
No documentation, no standards, no "good practices", no"good design", no software principles, no performance analysis, nothing.1 -
Best documentation?
Ucglib, a universal TrueColor library for many display controllers for Arduino. Seriously, this thing’s documentation is fucking SICK. They include so many fonts on there, every single one is customizable and every customization is documented.
Worst documentation?
Probably the Objective-C syntax documentation, it’s DIABOLICAL, you have to, first of all, FIND IT. After that, you need to understand the shitty language.1 -
I spent the last hour of writing the documentation for my javascript class. I should be proud, but all i feel is tiredness...
-
I should try to put ascii arts of pepe memes instead of meaningful error handling messages in my code, this way I would know for sure if people are actually not just patching fucking try catch silence everywhere instead of doing proper code.
I should probably do the same with documentation as well while being at it. -
Do you think AWS will still be THE thing within 5 years? Trying to learn REST/cloud/database stuff as a junior dev, but I'm having trouble with the pile of shit documentation.4
-
Spent about 40 minutes trying to figure out why my stupid events were not tracked, something about CORS
so digged into the htaccess file and added the correct headers but the header value was being appended although i was setting it.
So I figured the "tool" i am using is setting it too but only when I set it, that was weird.
So on to to its github I went, someone mentioned there is a CORS setting in the UI, so I added the domain i wanted to allow and done, it fucking works.
Read the documentation kids, sometimes it is useful. -
Documentayion my ass!
Whoever wrote that documentation for qutebrowser: You fucking apathetic shit nugget, you have a fucking feature over there and all you do to fucking document is to hide it within a indifferent example? How the fuck am I supposed to configure that shit if it isn't even mentioned wheresoever? You're example simply assumes that the reader has all the background knowledge and nostly lack relevance as much as IT in my highschool. Read that shit yourself and tepl me if you can find out how to configure this BS3 -
Once upon a time aka last week,
Was trying to fix an industrial automation software coded in Codesys. My company's standard library is riddled with bad documentation with a mix of English and German terminology.
Had to find out why a program kept crashing the program upon start up. Long story short and many stressful hours later, I found two functions in the standard library that caused an endless terminal process loop. Had to wrap the function in an 'if statement' so it would only run once. Function should have done this by default. -
Writing documentation is one of those tasks that most developers don't like doing. Especially when it comes to writing in say a Word/PDF file, an online wiki, or Confluence. It's time consuming and a pain in the ass.
But even if you don't like it, at least write comments in your source code! I hate having to keep writing "Write the PHPDocs for this class/function" in every pull request that I review. It's wasting my time writing such comments when it's such a basic thing to do when writing source code.24 -
I hope there's a special kind of hell for project leaders / execs that make the decision to take down the documentation for older versions of a software.
I know we should have upgraded a long time ago, but come on. I have no clue what's going on now, and not much to go on either! All the documentation links in the configurations just redirect to the project's github repo, and I sure as hell am not going to read the whole source code just to find the possible logic behind the issue!
Ugh... Days like this frustrate me so much...2 -
Wiriting documentation is the single most boring thing I can imagine.
Fuck, it'd be more entertaining watching paint dry, or seeing the grass grow.6 -
NPM modules are supposed to make us save our time, but very often, after hours and hours of juggling I end up write by myself those fucking functions.
And I'm not talking about unknown packages made by a bored guy in a lazy Sunday, I'm talking about fucking well known modules like passport. OH MY GOD. How much sucky is the passportJS documentation? There are fucking hundreds of options and they are not referenced anywhere if not on StackOverflow. When you login in a website thousands of things can go wrong, why the hell do you always send that shitty 401 and you don't let me control the code? They are two fucking days I'm trying to fix it and I realized I could write that function in 2 minutes if I just didn't use passport. FUCK7 -
Dialogflow documentation is ABSOLUTE TRASH. Trying to run the example code? It gives you a super helpful error: `Unexpected error determining execution environment`. Uh, yes, indeed. What it means? IT MEANS THAT YOU PROVIDED NO CREDENTIALS. Because, as we all know, providing no credentials should end in an error of 'determining execution environment', of fucking course.
You want to know how to provide credentials? Think again, all examples in the ENTIRE DOCUMENTATION assume that you're running the code... from their servers. Seriously. You wanna know how to authenticate your shit? NOT IN THIS DOCUMENTATION, LOSER. You want to know what exactly is happening when you're initializing your client with `new dialogflow.SessionsClient()`? Good luck, documentation is on another platform. For .NET. Because fuck you.
Also, you think you can store your auth info in a neat .env file? THINK AGAIN, because google is above such petty things as industry standards, you're getting a .json file and you're gonna like it, HAVE FUCKING FUN.
Dear google, die in a fire.
Sincerely yours.1 -
Trying to learn <insert name of programming language>...
Can't find any useful documentation or examples.2 -
From Documentation:
"A SHA256 HMAC is created outside of Bronto. If you need help with this step, contact one of the developers at your company."
Yes because, cause every company has a developer.
*Only developer at company* -
This is an example if stupid documentation.
//Just like magic
try {
....
WTF! THIS IS PROGRAMMING, NO FUCKING MAGIC OR MIRACLES HAPPENS.1 -
Now let me just throw away most of this pre-work documentation from the PMs and do it right the first time.
-
Dev: "read the documentation i write its simply easy to understood"
Me: Yeah I can figure that much. -
Oh god why... Why is it that every time I work with software defined radios, I keep on having to rely on not just incomplete, but at times misleading documentation 😩
Last time was GNU radio, with the doc telling me that I could define an input for a processing block using either a type or a (type, size) tupple, only for the actual code to scream at me in confusion upon my passing a tupple.
Now is that other SDR's SDK, which, as if being built upon eclipse wasn't bad enough, managed to make its serial communications confusing. Why can't you just let me set a callback to rx interrupts, you daft punks...1 -
So I use Git intagrated in Visual Studio for the project's repository at work. But I don't like using it because I always used the command line to do stuff on my projects (including those at school, plus last time I used a GUI, I managed to do a merge without being conscious about it).
Why can't I change ? Well, because the proxy block every download link. Or almost.
So a documentation that was updated like 9 months ago was explaining things, and mentionned Git by provinding links to download the bash version. Happy, I click on it and try to download it.
Proxy blocked it.
Just fucking update your documentation1 -
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.
-
Fuck this documentation is shit! Param names aren't correct and some API's expecting a different parameter than it is even named for!
-
When and how do you improve documentation?
I dont mean "added new/refactored code, gotta document it" but active improvement.
Which feeback channels do you have for your docs?3 -
Spent an hour today deciding if something in my framework should be called functions or methods... Decided on methods and had to rewrite half of my documentation.... Productive day...
-
Ok I fucking give up, does anyone know of any tutorials on adding custom languages and syntax highlighting to VS code, I followed what little readable documentation overlord Microsoft has given and still no fucking clue, help!3
-
#get unique images ids
images_ids = np.unique(images_df.index)
Dear developer who wrote the code I'm looking at,
thanks, I really need comments like this one. I was wandering lost in 1500 lines of code, looking for an explaination of what the actual fuck the code is doing, and there I see you, comment. It's not like I want to know what the hundreds of lines functions do, who cares about that. What I needed to know, what shed light on this dark forest, is what the numpy functions do, because as you certainly know dear developer, such functions are really hard to comprehend, lacking of documentation.
Thanks.2 -
Been working frontend on a very large ASP.Net Core project with React. The company is a multi national oil company. I asked for some documentation on their React components, like where is the props, why is this component showing this side-effect and is there a component for X and Y so that you won't have to pay me in order to dig around in the codebase? They told me they will document the frontend when the project is finished (whenever that may be?)
So basically, there won't ever be any documentation then.3 -
Enterprise software companies that can't take the time to include even a bare bones admin manual. Scattered documents don't cut it guys.
-
I fucking hate documentation.
It's been 5 straight hours I've been preparing documentation for the "In-House Project", because apparently it carries the grades which is necessary for me.
Fuck this shit...2 -
I really hate working with learning management systems (LMS).
I make training simulations for retail companies and some of these have the worst, backwards LMS's out there.
The providers who install and manage these LMSs for the companies always insist we make our training run inside their own environment, but we can't since it's a 3D training made in Unity that doesn't run well in a browser.
Luckily some of these are fine to figure out. Just a few API calls here and there for authorization and reporting progress, but some are an absolute nightmare.
Just now one of the providers provided me with a 2000 page documentation of all the functions of the LMS's API that our customer is using. All I need are like 5 pages that explain what URL to call with what data and the responses, but now I'm stuck spending days trying to find the 0.5% of this documentation that I need to communicate with their API.
And of course, the documentation is vague as all hell. minimal descriptions of what each endpoint does. Subjects names are super vague, as in do I look for course progress or lesson completion state. What the heck is a Learning Event, is it relevant to me?
And the errors in this document, too.
Bullet-point lists with duplicate items.
language errors everywhere.
Property lists where they copy-pasted the description of properties.
An entire EMPTY chapter, literally a page with only the chapter's title.
I just can't stand how these providers barely seem to know anything about the API of the LMS's they provide to customers.
(for clarity, the LMS is produced by some big tech company, it's installed and maintained by some 3rd party which is our main line of communication when rolling out trainings to these).
It always goes like: "Hey, we want to use your training." "Oh, that's great, we have our own, simple LMS where you can view your employee's progress." "Nah, we want to use our backwards LMS. Here's a giant manual about it's API, go figure it out!"
And then I'm left here tearing my hair out trying to figure out which 3 calls I need to send their API from the tons of extra stuff it can do which is completely unnecessary and being unable to rely on the provider because they lack the knowledge and have such thick skulls about the implementation of the LMS itself that they also seems completely unwilling to help to begin with!
Just another day at the office. -
!!rant && !documentation
Hm, let's see what a semi-beginner can find as a project in Python...
Oh, an API Wrapper seems interesting! *full of joy*
Okay, let's look at the documentation...
HOLY FUCKING SHIT. IT IS UGLY. IT IS INCONSISTENT. IT IS INCOMPLETE AND WRONG. WHY THE FUCK, AREN'T YOU STUPID ASSHOLES CAPABLE OF WRITING DOCUMENTATION FOR YOUR API?
HMMMMMM?
YOU STACK OF SHIT.
IF YOU HAPPEN TO CREATE AN API, AND DONT DOCUMENT IT CAREFULLY, I WILL FIND YOU.
AND KILL YOU.1 -
Fuck undocumented shit!
I was wondering how to use this one method of the "interface". Googled the name of the program and the specific method.
Got two results.
From the same page.
It's a comment complaining that this shit is undocumented and doesn't work.
If you build something that others use, please, motherfucking please, document your code.
At least some auto generated javadoc, how hard can it be?
You are using the atlassian suite for everything and you have confluence so use it already! The only documentation that actually exists it about a hundred years old, totally useless and covers about 1% of what your product can do.
I like your product but fuck me sideways your documentation sucks balls! Fuck!
That needed to get out. -
Yet another probably final Hacktoberfest swag
From Umbraco
Received by improving documentation
Thanks to Umbraco for sending stickers which were missing in my pack ^v^
-
Aah documentation... My workplace documentation is mess, some parts are from year 200x and they don't work at all sometimes. It's really frustrating to learn our internal development language cause you can't trust documentation that much, or at all sometimes. Perhaps I start developing by updating documentation.7
-
Just started working on Alexa skills ,
And I must say , feel like a dog lost in a pool of balls plastic balls, while am chained to a pole. So much I can do.. but there’s no documentation as to how things work
All the docs available are old, and I didn’t really understand how things are working5 -
This is yet another rant about php.
But I'll put my hands on first: I'm less than a junior and I'm looking for a backend language to learn.
So far I've been looking at php with Symfony because it's been used where I work.
Is it my impression or Symfony somehow overcomplicates everything? Like I don't know, for any stupid thing I get stucked (like yesterday, spent two hours on a circular reference problem with serialization).
Also, I don't like it's documentation. I am a book person, meaning that I need pages of text explaining how the framework (or whatever) works in a precise order.
Symfony's docs are like a graph: you often have no idea where you are or "what comes next".
Also, I feel like every page makes you just copy-paste everything without explaining very much what's happening under the hood.
I know there is a cookbook, but it's pretty outdated (like it's at version 3 or 2.7, I don't remember).
Is it just me? Do other Symfony developers experienced the same?10 -
Our team has to add some features to an existing application/platform. Its a mobile application with a server handling all the logic and a database for records storage. Fairly big project, a few 1000 lines. Ohh and did I mention that there is absolutely NO DOCUMENTATION???! Why on earth would you even be like ohhh let's do this project but write absolutely no documentation for it! Why???1
-
Today, or wednesday (can't do anything tomorrow, family is coming over) I'm going to start writing documentation for my project.
Problem: Never wrote documentation before.
I only have the database done (still need to write the migrations and seed, but the structure is done). How do I even write documentation for a bunch of tables? I guess I'll learn that this week.
Wish me luck, I'll need it!! -
How do the companies you work for store company secrets/documentation? Stuff like bitbucket, GitHub, Google docs?8
-
If what I'm trying to learn is visual, video tutorials are useful. When it comes to programming, it sometimes wastes my time. Watching a 5-minute video to accomplish one simple thing? I could never get that time back! You can spend half of the duration of the video introducing yourself but I am already frustrated. I prefer documentation and hands-on most of the time. Just sharing my thoughts. Thanks.3
-
The only thing worse than having to write documentation as you code is procrastinating it to the end...2
-
When the documentation suggests you use composer to install swiftmailer so I can use sendgrid.
Even though I can install composer as an extension and sendgrid is integrated within the portal it's down to me to work out the azure cli or is it a powershell cli or is it bash?
Echo gives kudu error, oh well if there's kudu why am I using composer?
Grrr azure you don't make it easy. -
LONG MS WORD NIGHT DETECTED
I have to work on a high level document, low level document, SAC document and a use case script for me to get QA approvals.
**CLOSES EDITOR **1 -
Documentation-driven development, we need to start treating documentation on the level we treat code. Thoughts?2
-
Providing a nice Readme.md file with your open source project is never enough. You need to have a beautifully designed website for the documentation to go with it, oh yes sir!1
-
I'm finishing up some software I designed, any tips for writing documentation for non tech people?5
-
Why does the documentation in the website for API doesn't include the optional parameters to use?
Why are you making my life harder!
Good thing their github.io docs has the documentation for the parameters I needed.
So, why not include it in the official documentation?! -
Hopefully, simpler sintax.
And better documentation for every language/framework. Especially for the devs who are just starting, don't write documentation assuming everyone has been working with your framework for years!
That last one was more a rant than answering the actual question, but I needed to say it. It's been on my mind for a while 😑2 -
Integration of with another web service.
The only documentation it's a Skype chat.
😝😝😝
Save the chat content as text: It's the bible of this service.
Can someone write a text on the stone for future needs?
Please help me !!!!
2 -
I would like to understand xcb library by looking at the rofi (dmenu replacement) source code but there is no code documentation. How do you guys deal with non-documented source code (supposed to be easy)3
-
I took over an application that consisted of 4 MSSQL (2005 at the time) databases, hundreds of tables, thousands of stored procedures, maybe a 1/4 of them actual still being used, external links to more than 20 other databases (MSSQL, Oracle and DB2) which all ran from a single "master" stored proc that was kicked off nightly by scheduled job.
The existing documentation consisted of a single word document, about three pages long, describing how to set up the application... on the Sql Server 6 server it had been originally created on two generations ago. -
Question: What tools/software do you use to write API documentation of applications with NodeJs back-end (assuming that you can not use tools like ex: sweager for weakly typed languages)?2
-
Community Question:
I'm on a lone-project for work. That means I have to make a design plan and documentation. I have zero experience with this, anybody know a good example on the web of either of these? Much appreciated!2 -
Is there any simple documentation editor that allows html export? I found this template: http://surjithctly.github.io/docume... and could of course just write myself something, but is there anything out there that produces such similar/simple docs?2
-
Wondering is there good designed template for API Documentation.
Or is there any good tool to generate automatically.?3 -
!!rant
Elasticsearch! First time touching it and need to find out on my own how to build an index that allows a weighted multi field fuzzy search on four fields where two needs to be full ngram, one ngram on the words and one standard search + not index any other field. The documentation is horrible! Just realizing that this is what I need took me 2 days!2 -
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 -
To most non-dev people, being hit with error after error when fixing one small problem out of a much bigger collection of problems would probably be infuriating.
To me, it's a huge loop of:
for(var failsAtLine = 1; failsAtLine < lines.length; failsAtLine++;) {
changeSomething();
runTest();
readErrors();
cry();
comtemplateMeaningOfLife();
}
openChampagne();
Would help if deployer.org had better documentation and bigger support community.
-
Is there anyone out there who knows opennms? I got assigned to "improve" the nms diagnostics page (graphs are drawn and shit) but I can't find any dissent documentation. My task has even been changed to "if you solve the problem, write down a documentation on how you did it"
So yeah... Feeling lost.. Not even a SO thread to help me 😳😖1 -
Google got documenting right. Any product from google got a solid documentation — change my mind.12
-
Been working on integrating mail gun into the MVP of the webapp I am creating. Couldn't figure out why I kept getting a 400 response. Check the mail gun documentation and realize that it's expecting post parameters not JSON...
Well there goes those 5 hours. -
Isn't it great when you get urgent tasks, but the documentation required for it can't be found or doesn't even exist, and the devs that worked on the project before are no longer in the company? And then the producer gives you some document that is completely unrelated?
-
Ahhh, this kindda makes me sick...
Wrote something.
Wrote documentation - 2 weeks.
Changed few things and refactored - 3 days.
Refactoring and updating documentation - week and counting.3 -
our office software has the shittiest documentation. no problem! i love to browse all the subfolders to find where to place a serial letter template! why would someone want to do this in the first place?
if someone working in the german medical field: i can not recommend eva/viva for some other reasons as well. -
Is there something like a documentation-viewer app for android-phones?
Something where I can choose a lang and then search the documentation of the standard-library.2 -
Trying to use a certain library for my ORM needs. It seems that the devs 'forgot' to add decent documentation.
Also trying out another library to integrate with it. Again, no decent documentation.
It pisses me off how A LOT of Node.js libraries have the worst documentation ever, and if they do have some seemingly okay ones, they conveniently leave out the more complex functionalities. What do they want to achieve here? For people to head to their Github pages to sniff at the code?
Holy fucking shit. I hate you people. I even hate having to use these in the first place. -
looking for suggestions for a self hosted CMS. I tried Ghost, and it looks real nice, but there's no option to have just 1 section be private, you can only make the whole thing private. I tried Drupal but honestly it's just way too complicated for what I need, and doesn't look very aesthetically pleasing.
basically, here's the features I'm looking for:
- ability to set privacy/access control on a per-page or per-section basis
- Markdown for content editing
- ability to use regular HTML when needed
- ability to upload content via an API (so that I can publish documentation via my gitlab CI)4 -
Why does the biggest mobile money payment system in our country have such crappy documentation! Arghh
And they tell us to read the DOCUMENTATION it has all the answers -
fuck you onelogin, saml and corporate login for being difficult to setup and understand (still haven't achieved either)
also fuck you outdated documentation
when you drag in a senior to help you and they think you're a retard (true), "just read the docs" (attempted), you have them try to babysit you through the setup and they realize the docs are not up to date/retard proof enough to get a proper setup on your end1 -
Is there any good freeware to make an IT-Documentation from every Device witch is connected to the Companies network?4
-
Just wasted two hours finding out why one of our clients rest API is not working. Apparently it needs a referer header for no good reason and this is no where to be found in the documentation...
It is great that you even have documentation, but please include all basic details!! -
What are your favorite tools for a knowledge base? Like where you collect documentation within a team5
-
Fuck you, BouncyCastle. I really like you but the way you have documentation. It's annoying. Nice name. Cool project.
Here, I'm write Java Docs for JUnit tests! For every damn test case!
So damn less documentation even SO said mind your own business! It's been more than 15 hrs. Not a single reply! I died a little today. They have examples but they are not really "examples". No passion at all for documentation!
You should watch and learn from AssertJ docs. OMFG @joel-costoglia sets standards for code style and docs before pull requests. The examples are LOTR themed for god's sake. I'm not asking for fluent API. I just want docs. What class does what. A simple program structure required.
Dyn4j, deeplearning4J have wonderful docs. Why not BouncyCastle?!!!!!
-
Autodesk's documentation in general must be the worst documentation ever made!
Im shocked that a company creating a HELP TOOL wont even provide structured and decent documentation! -
!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 -
Hey! It's been a while that I've been searching about projects documentation in order to develop a template for the company's projects.
My goal at the moment is technical documentation, like getting started (for new developers), the project's dependencies, conventions, etc.
Does anyone have suggestions of articles, books, or any resources about that topic?
Edit: I'm planning to build this template, discuss it with the seniors and then present it to the managers.1 -
Code examples with dozen of lines in the project documentation (docx) are screenshots... lazy to format or to prevent simple copy and paste? That's the question.
-
I need to have a hosting company upgrade the Debian OS install on a VPS. But I also need to know things like what MySQL or Perl modules were added to the server by other admins prior to me outside the /home directory. I don't have any documentation on it at all. If I don't preserve custom stuff like that, it could result in a dead website. Anyone got any tricks for figuring out what was added and when?5
-
if you need to make XML documentation comments in Visual Studio 2019 and you don't feel like doing it (like me), I recommend this little extension: https://marketplace.visualstudio.com/...1
-
My testing team just asked me for documentation for a screen a webapp. I had to make a small change in it which was regex and had to allow another char, which was quick fix. The code has single letter variables and huge java code in jsps,
How can i even find a documentation for it. -
Developing in Unity for Android.
>install UMP Pro for Android, iOS from assets store
>latest version on store: 1.7.3
>documentation in the plugin itself
>wow that's rare!
>open documentation
>"User Manual"
>"Version 2.0.3"
Wtf? is this documentation coming from the future?
Top Tags
Weekly Rant
View