alt Hacker NewsAnd, to be clear, the README was mostly an initial prompt for the AI. I’ll prioritize making a much clearer and legible README soon
Replies
assumed_throwaw • today at 5:39 PM
A good tip is to actually polish your README before sharing it with everyone.
➕ show 1 reply
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:
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.