←back to thread

Red Hat Technical Writing Style Guide

(stylepedia.net)
196 points jumpocelot | 1 comments | 10 Jul 25 15:01 UTC | HN request time: 0.23s | source
Show context
david422 ◴[10 Jul 25 18:07 UTC] No.44523818[source]▶
This seems like one of the perfect use cases for AI. Have the AI ingest the style guide, and then comment on your written work to point out where your work does not adhere to the style guide.
replies(5): >>44523919 #>>44523975 #>>44524050 #>>44524434 #>>44525933 #
1. irskep ◴[10 Jul 25 21:41 UTC] No.44525933[source]▶
I threw together a vibecoded tool to do this, as a personal experiment. It splits the guide into several runs, each focusing on a different style guide section. Here's the diff it gave for the Claude-authored README for the tool, which I called 'edit4style': https://gist.github.com/stevelandeydescript/14a75df1e02b5379...

And here are its style comments: https://gist.github.com/stevelandeydescript/a586e312c400769b...

I don't plan to release the code, since I don't really want my docs to be written in this voice. But it doesn't feel entirely unhelpful, as long as I'm personally curating the changes.