Hacker News Reader

Comment by KingOfCoders | Hacker News Reader

I think when you create a website (write a document, write a README) it is important to imagine the top 3 reader/visitor personas. What do they want from the README (website)?

  1. Go+SQLite user: No CGO
  2. Go user
  3. Wanting to use the library
  4. Someone following a link from HN
  5. ...

View on HN

Agreed, although I think a brief one-line intro to what this thing does wouldn't really interrupt the flow for any of the above use-cases. Right now, the top of the README is a list of sub-libraries, listing the library first.

Personally, I would add ~2 sentences in the order I outlined, and then I would reorient the list (currently library-first) in a use-case first arrangement like you mentioned.

I mean, realistically my git repos are a mess, so who am I to talk? But this one looks promising enough such that it's worth offering a bit of feedback.

Agree,

4. Someone following a link from HN

I'm often confused when clicking through from HN and can't figure out from the website or README what the project is doing.

Thank you for the feedback! I tried to improve the copy a bit, but this is clearly not my thing…

Sometimes you want people who don’t get it to bounce.

Keeps the signal to noise ratio higher.

Reply on news.ycombinator.com