3 ms·
Good advice. There are a few nice tools out there to support technical writing. I think one of them was featured on HN a few days ago: vale. This is a tool tha
by jillesvangurp 4y ago
Good advice. There are a few nice tools out there to support technical writing. I think one of them was featured on HN a few days ago: vale.
This is a tool that allows for applying simple regular expression based rules to enforce style rules. The idea is that you can tune this to your needs and cover all sorts of stylistic rules. For example, gender neutrality might be a desirable thing in the documentation for some tech companies and you can get it to flag things that are clearly not gender neutral.
Another thing worth mentioning is Jetbrains Grazie Professional (warning it's different from the normal grazie plugin, which is confusing), which actually integrates vale and can be used as a plugin for editing both code comments and markdown files in Intellij and other Jetbrains IDEs.
In general, treating text like you would treat programming code as a thing that has rules that can be figured out and enforced is a good mindset. I learned to write coherent text while doing my Ph. D. a long time ago. At some point I figured out that anything I'm doing consistently wrong, I can just learn to do consistently right. I just need to be open for criticism and figure out why something is wrong/not ideal. You kind of learn to look for things that you've done wrong before in your own text and then you fix it. A lot of these rules aren't rocket science. You just need to know about them. There's a whole grey area between grammatically correct and stylistically pleasing/acceptable. Having tools point out things that are likely problematic helps.