To all #FOSS devs, I'm an experienced #writer and #proofreader, so please get in touch if you need my (free) services (e.g. for #documentation). I'll happily give as much time as I can spare.
#proofreading #editing #writing #development #opensource #git #gitea #github #gitlab #codeberg #sourcehut
@syntax well, I could really use somebody looking at:
https://samizdat.is/
https://0xacab.org/rysiek/samizdat/-/blob/master/README.md
And helping me make it more readable/understandable.
Problem is, this is using technologies that even many web developers are not yet familiar with, so it's really hard to convey what it does, and how.
@rysiek
Taking a brief look at the copy I can see it's well written, but there are a few things (mostly minor grammatical) which could easily be fixed. I could take a closer look if you'd like and create a PR? Let me know your thoughts.
@syntax PR most welcome, thank you! :) I was thinking also about taking a step back and perhaps making it more readable to non-techies. On the fence if that's what's needed, need a reality check on that (hence asking).
@rysiek It's a good idea. I think well written and easily digestible documentation is really important for software, especially when it's on the technical side.
While some users may be able to quickly grasp what's going on, others may be put off if they can't get to grips with how to use it. It's a fine balance, I suppose.
If I have any other broader suggestions while I'm looking through it, I'll be sure to let you know.
@rysiek 👍