Hacker News Reader

Comment by jordan_bonecut | Hacker News Reader

And, to be clear, the README was mostly an initial prompt for the AI. I’ll prioritize making a much clearer and legible README soon

View on HN

If you want to have an LLM write your README (and other docs), I've found it useful to add a DOCS-GUIDE.md to your project and write your conventions and expectations there.

Google has a two-part technical writing crash course:

  - https://developers.google.com/tech-writing/one
  - https://developers.google.com/tech-writing/two

I've had good success with adding a directive to the guide that points to those two URLs and tells the agent to adhere to them in all of its documentation.

A good tip is to actually polish your README before sharing it with everyone.

I considered waiting longer to share more but felt feedback early was better than waiting for more polish. Will focus on this with high priority though, good feedback

I think you might want to more deeply consider the impact it has on people when you ask them to read a bunch of LLM-generated code and documentation that you haven't even taken the time to "polish" yet. Some (myself included) might consider it a violation of an implicit social contract to expect such disproportionate effort from your audience than you are willing to spend yourself upfront.

Maybe, to put it another way: Why should people want to spend time developing feedback for you when you were not willing to spend commensurate time on the things you want to show them first? You're putting the cart before the horse.

I agree with you, if I were asking for a code review. I'm mostly interested in what people think of the language features. A code review in its current state is not interesting, but I believe the site has some ideas that can be food-for-thought

Reply on news.ycombinator.com