Either donate or write the documentation yourself, complaining about unpaid FOSS devs and maintainers doesn’t do anything
Once again, “I don’t understand this, I guess it’s up to me to explain how it works.”
I didn’t go to software engineering school. I went to flight school. Reading and understanding the source code of an application as large and complex as FreeCAD is outside my skillset.
I’m a flight instructor. I can and have taken people from never having flown a plane before to licensed pilot. You want me to teach flight school, you’ve got to give me the plane’s POH. It is not my job to write the Pilot’s Operating Handbook. It is my responsibility to teach students how to read it.
You get me good documentation for this software I’ll create and publish a course on parametric furniture design. But I’m not going to sift through source code trying to figure out how to write a macro any more than I’m going to pull the panels off a Cessna and trace wires to figure out what the switches do. That is the responsibility of the people who made the damn thing.
Then donate money to the project
I’m pretty sure I can demonstrate that doesn’t work; people have donated more money to the project than I’m capable of giving alone and that didn’t bring about usable documentation. The definition of insanity is watching other people fail and then doing exactly what they did.
I’m sorry you’ve had a poor experience with FOSS software, I’m sure the project will give you a full refund if you ask them.
You know what? That’s okay, I’ll just switch operating systems to Microsoft Windows or Apple MacOS and start using Autodesk Fusion360, paying hundreds if not thousands of dollars on a recurring basis to at least two American corporations that directly support the rise of fascism. I’ll be directly financially supporting everything from AI slop to the abduction of academics in broad daylight but just think of the fives of minutes I’ll save over the next decade drafting cabinets.
Unethical pro tip: write obviously wrong documentation, post it somewhere, and then wait for people to flame you while explaining the correct methods.
I’m ashamed to admit I’ve done that a couple of times when I was completly ignored for straight up asking how to do something.
Murphy’s Law: the best way to get the right answer on the internet is not to ask a question; it’s to post the wrong answer
This is the fastest and bestest way. And this is the reason Wikipedia works lol
The good thing about OSS is you don’t have to be a programmer to contribute.
If the documentation is lacking you can write up a one pager and submit it to their wiki for integration.
https://wiki.freecad.org/User_hubHow am I supposed to write the documentation for software that I have no method of learning how to use?
Read the wiki, experiment, and improve it.
But indeed, CAD is a very specific way of thinking, and if you haven’t done any technical drawing course you won’t find it by yourself
You want to play a fun puzzle game? Go figure out how to get basically anything done with the macro/scripting system. The app exposes a Python console to the user and they didn’t bother to publish an API reference so you’re left resorting to the “dangle a cat from a string and hit it with a stick to see what falls out” method of veterinary school. Why is being open source an accepted excuse to force users to attend Pinata University?
This is what I tell my co-workers:
Don’t come to me with a question and ask for the answer. Come to me with the answer that you came up with and ask me why it doesn’t work.
In other words, at least try to be the solution. You’re more likely to get help from those who can help you.
Start writing the documentation. Fill in everything you know. There might be people you help who don’t know as much as you.
Post about it, and give others the opportunity to correct your documentation.
Open the source code and see if you can start to work out the API. It’s all in there. That’s where the people who are writing it are documenting it.
If you put the effort in, then you’ve joined the team, even if no one invited you. Once you’re on the team, the people writing the code will see you as a contributor and they’ll be more willing to put the time in to help you.
Okay, let me ask you this: Why would the developers of FreeCAD demand their documentation be that inefficient and poor quality?
I mean, we’ve got two options here:
Option A: The developers of the software, the people who already know how to program at the application level, who are already familiar with at least some of the codebase, could write down what all the features are and what they do. Armed with that basic documentation, power users, folks who are specialists in using this class of software for its intended purpose, can create tutorials and coursework to teach people how to make projects in it, or create and share useful macros and extensions and whatnot, building the ecosystem, of our app specifically and FOSS software in general…OR
Option B. We can get weirdly pissy about it and insist that those end users, people who don’t have a need in their lives to know how to write software applications but do have a need in their lives to use mechanical engineering software, to gain enough proficiency in not one but two programming languages to examine the source code to figure out how it works and write the documentation themselves. The best case scenario here is it wastes a whole lot of manpower of competent coders who now have to read and familiarize themselves with someone else’s codebase. Meanwhile, a lot of smaller contributions that end users would have made get abandoned because the support they need to do that deliberately doesn’t exist. So adoption of our app specifically and of FOSS in general chills, we continue to maintain FOSS’ reputation as unusable garbage made by damaged nerds, and the people will continue to say “I would switch to Linux but I need functioning CAD software for my job/hobby so I’m going to have to keep making large recurring payments to corporations like Microsoft and Autodesk who directly support the rise of fascism in the West.”
OPTION FUCKING B IT IS.
By watching YouTube tutorials or turning on the monkey part of our brains and poking around in the software until something happens.
Pay them?
How do we get the makers of FreeCAD to document their fucking software?
It’s FLOSS. You may not like that but it’s up to everyone of us to contribute to make things better. With our time, with our money, or with our expertise. And there is no fucking need to be fucking mad at anyone for not fucking doing it for you.
Or you can spend the money, time and expertise you don’t have for FLOSS on shiny Apple or Microsoft proprietary apps so they can keep on not making good documentation and not giving a fuck about it. It’s fucking up to you.
