Do you mean how to install their software or do you mean how the code works?
@onepict Developer documentation is about how the code works... Installing the software is a subject for the user documentation...
So in what way are Framasoft and Invidious failing? Criticism is valid but it needs to be explicitly explained if you want the developers (one of who needs a rest, and there's alot of folk feeling left in the lurch) and the community to listen. Is it not just the documentation is it also a failure in communication by the developers?
@onepict When projects are developed by single developers, it's particularly important to have thorough documentation:
- to facilitate uptake for potential coding contributors;
- to ensure maintainability and possible continuation of the project, if the original developer falls by the wayside.
Proper developer documentation is even more important when projects seek to accumulate communities that become dependent on the software.
Preaching to the choir here. I'm just trying to find a way to communicate that with others. We can't just sub toot it. We have to be explicit. Which may lead to some arguments.
Which I hate the idea of. I'd rather just have a discussion and have it lead to some form of consensus. But for it to get there in this space everyone's cards need to be on the table with explicit reminders of what the particular rules are.
@onepict Ahh, Esther, it's flogging a dead horse, anyway... I can post it in French, too... But it won't persuade those devs anyway 😞
I'm just hoping that perhaps one day when new developers/projects come along the points we make sink in. It does feel pointless occasionally, but I feel it's important someone states this. If nothing else it means if folk say "oh no one spoke up to us about this" there's a record that shows some of us have. If only to encourage more of the silent community who does agree but are scared to speak up to do so. It's a measure of a community on how it reacts to queries or criticism.
chaos.social – a Fediverse instance for & by the Chaos community