this post was submitted on 20 Dec 2023
158 points (88.0% liked)
Asklemmy
43757 readers
1181 users here now
A loosely moderated place to ask open-ended questions
If your post meets the following criteria, it's welcome here!
- Open-ended question
- Not offensive: at this point, we do not have the bandwidth to moderate overtly political discussions. Assume best intent and be excellent to each other.
- Not regarding using or support for Lemmy: context, see the list of support communities and tools for finding communities below
- Not ad nauseam inducing: please make sure it is a question that would be new to most members
- An actual topic of discussion
Looking for support?
Looking for a community?
- Lemmyverse: community search
- sub.rehab: maps old subreddits to fediverse options, marks official as such
- !lemmy411@lemmy.ca: a community for finding communities
~Icon~ ~by~ ~@Double_A@discuss.tchncs.de~
founded 5 years ago
MODERATORS
you are viewing a single comment's thread
view the rest of the comments
view the rest of the comments
What use is a readme written by someone who doesn't know the code, doesn't know the internal designs, the design goals, the plans of the current maintainers, anything? It'd be no better than asking ChatGPT to write it for you.
Yeah, that's a good point, but the readmes that I've seen written by those who wrote the code themselves are not much better. Sure, they know what it's all about, which is precisely why it oftentimes isn't much help for a user.
What's needed is someone who'd read the initial readme (written by the guy who wrote the code itself) and ask questions about the parts that were "too straightforward" to be included, or weren't explained clearly enough, or to bring down the general overview back to Earth.
And if there's yet another person who'd go over this second pass, and keep it from being too dumbed down, even better. Keep it to the level of the average user. That requires knowing the kind of person who'd likely use the program.
I‘m sure a lot of people who correct text, add references, structure and pictures to a readme would disagree with you.
I‘m not sure if you‘re a coder but it you are, you should know that coding and usability are two entirely separate things.
Oh...
You don't mean the readme file. You are talking about the manual, or the explanations on the website. Yeah that can make sense. Though I would still say it's weird if you're not too familiar with the direction the application is going, but an experienced user can of course help create better texts and pages for that.
Easy, just click the whatchamacallit, and add that little do-hicky!
This is why all my methods are called ˋdoStuffˋ.
Exactly. Thanks :)
Why does it have to be documenting internal designs, architecture, and all that? Why not app user manuals or install guides or any of myriad other sorts of documentation?
Just because one specific scenario may not be suited doesn't mean no scenario is suited to what op is proposing.
I mean first, what kind of projects are we even talking about, libraries? APIs? Apps? Command line tools? Etc?
Because the technical writing needs vary depending on what kind of project. They don't all require coding skills for success.