3 ms·
As a technical writer, I use Vale every day. It helps protect consistency and style. I wrote a brief tutorial here: https://passo.uno/posts/first-steps-with-the
by remoquete 4y ago
As a technical writer, I use Vale every day. It helps protect consistency and style. I wrote a brief tutorial here: https://passo.uno/posts/first-steps-with-the-vale-prose-linter/ https://passo.uno/posts/first-steps-with-the-vale-prose-lint...
- lifeisstillgood 4y agoThank you for this - an example of the config made it all so much clearer - I would recommended the author steal some of that post for their README To over-simplify, vale runs hundreds of pre-built regexes that suggest changes to over-used phrases, likely function names etc etc. Google etc have pre-built fairly good defaults I suspect. (To be fair this is trying to get consistency across huge document bases, and will never replace a human's authentic voice for communication. But sometimes you just want to make sure there are the same number of blueberries in each muffin) Ok - my mission after next - get something like this brought in at work
- remoquete 4y agoFeel free to reach out to me if you need some ideas. I brought it to work successfully and I’m now trying to get the rules to go open source.
- lifeisstillgood 4y agoThank you - I could not find your details in your profile - my email is in my profile so please feel free to ping me :-)
- mjrbrennan 4y agoWhat a coincidence, I watched Casino just last night!
- mooreds 4y agoI took a whack at using Vale a year or so ago, but was overwhelmed by having to either: * creating my own style guide * using one of the existing ones We have a DevDocsReadme that has some style rules we enforce manually. Is the best way to get going with vale to start with that doc and write rules for that? Can you apply rules to asciidoc and markdown source docs, or do you have to apply it to the end product (HTML, etc)? It seems like such a cool idea. Any pointers to 'get started' for existing largeish documentation sets would be much appreciated. (I will read your tutorial, @remoquete.)