Comment by jaggederest
4 hours ago
Well, if they're consistent, the ADR directory contains only human written text that drives the underlying development... Aaand it's empty. Well.
I personally would probably have the readme generated based on that directory as the primary document, probably with another `readme_generation_rules.md` in the ADRs directory, and I would be pretty ruthless about disallowing all the slop-adjacent wording.
> I would be pretty ruthless about disallowing all the slop-adjacent wording.
I’d think that trying to play whack-a-mole with slop like that would result in a lengthy prompt, as well as being brittle to future changes.
If you want the prompt to be the source of truth, you’re probably going to have to accept prose that feels like AI, at least until you can regenerate with some future smarter model.
Not even close :) It's really, really good at making natural-sounding prose if you demand it, set clear guidelines (ideally a script it can run with grading, but...), Fable in particular is eerie about mimicking prose style. Try RFC style if you want really clear architecture documents with MUST/SHOULD etc.
It will, of course, be slightly worse at the non-style task (i.e. make the readme worse), but if you care about the style, that's probably an acceptable tradeoff.