Top
Best
New

Posted by edent 11 hours ago

I paid people to try and follow my README(shkspr.mobi)
357 points | 184 commentspage 3
Neywiny 11 hours ago|
Yes. The amount of projects that don't just run is outstanding. Luckily docker container projects are inherently better at this is in terms of dependencies, but there are still often weird assumptions or medical incantations to get them during.
patrickmay 4 hours ago|
This is an underrated comment. If your project can run in Docker, providing a Dockerfile in addition to the README is incredibly valuable.
seqizz 6 hours ago||
Does the author aware the blog is unreadable on Firefox mobile? I might have something wrong on my phone too, but I don't have an issue with anything else.. https://imgur.com/a/ctriVnD
edent 6 hours ago||
You have pressed the "Drunk Mode" button on the theme switcher - probably on a previous visit.

Change the theme at the top and normality will be restored.

iamtedd 6 hours ago|||
That's the "drunk" theme the site has. Scroll all the way to the right in the switcher, and select "reset".
hobo123 6 hours ago||
Did you muck with the system fonts? On my Android FF it looks just fine, and yellow not black.
aleda145 9 hours ago||
I've done this for internal dev tools! It's amazing how many assumptions you have about everything.

I've great success with friction logs: https://mikebifulco.com/posts/how-stripe-uses-friction-logs

If you are a platform team, going through this with your internal customers is both driving adoption and making your tools better. Highly recommended!

irreverentmike 9 hours ago||
Hey - so cool to see someone else does this! Thanks for sharing my link, too. Glad you found it useful!
brookst 9 hours ago||
LLMs are also good for this; point them at your repo and ask them to do a fresh install and note all friction. One time when the lack of context really helps.
arbor-group 9 hours ago||
[flagged]
markx2 7 hours ago||
Not related to a README, but very much related to how programmers / creators speak (by which I mean type).

My way in to WordPress support back in 2004 was decoding answers to others from Photomatt and others.

A user would ask a question about WordPress and, for example, Photomatt would answer. His answer was always correct. Technically correct. But it didn't land for the question asker. They would reply with .. 'What?'

I would then replay with "What Matt has said is right, and this is what he means, this is the answer"

I gave them the information they needed in words they could understand.

It was not Matt's fault, it was not the user's fault.

It was translating in a way.

ozlikethewizard 11 hours ago||
"They were the ones who caught the mistakes that no spell chequer could."

Nice, good article lol. I appreciate a joke or two in a readme but totally understand the annoyance, I think forgetting to actually say what the software does is super common as well though. Often trying to figure out if something found on github will actually solve a problem only to be met with a list of install commands.

alienbaby 10 hours ago|
The 'look awesome project with funky name, here's how to install off you go' without a word to what one earth it actually does is amazingly common. Plenty of things posted here I bounce away from after hitting the linked page, finding something someone is obviously very proud of, but not having a clue what it's actually about :p
theletterf 10 hours ago||
Besides emojis, I find it too long. READMEs should be succinct and be like a switchboard to other docs (much like LLMS.txt tries to be for agents).

Also, it features an FAQ. FAQs are problematic (as in not often effective): https://passo.uno/what-the-faq/

Edit: Clarification

saghm 10 hours ago|
The link says "My opinion is that FAQs pose a problem only when there’s no strategy around their usage." Calling them "problematic" based on that seems like an exaggeration
emekcan 6 hours ago||
Same thing happened to me. The install command in my project's README was broken for one release. I didn't see it because it worked on my computer. I only found it when I tried on a new machine. Now we run that exact command automatically before every release.
iamflimflam1 7 hours ago||
This used to be standard onboarding practice everywhere I’ve worked.

Point new starter at the readme and get them to fix any issues (hopefully very few!).

pempem 6 hours ago||
What I love bout this is how closely it hews to the principles of design research. Same principles, applied deeper in the experience as LLMs make things more accessible than no code, or CMS before that.

All people creating, need to speak to other people. Loved reading this.

howard941 9 hours ago|
I'm so old that I remember when a software deliverable included documentation, and the product delivery was incomplete without documentation.
More comments...