Documentation as code: Part 3: A Linting How To - The Vale Linter in action (Demo) - Tag1 TeamTalk #027.3

Part One | Part Two | Part Three

PART 3: DEMO - SEE IT IN ACTION

In part 3 of our Tag 1 Team talks about documentation as code: linting for prose, we demonstrate the Vale linter in action. This open source linter for prose is highly customizable, making it possible for writers with little coding experience or developers with little writing experience to start testing their work.

In this Tag1 Team Talk, Michael Meyers (Managing Editor at Tag1) and Lynette Miles (Principal Technical Writer at Tag1) talk about integrating Vale into your workflow on the command line, or as part of an IDE, show a few tests, and demonstrate how quickly you can make changes to your tests, enabling your writers and your developers to work from the same expectations.

Links:

• Introducing Vale, an NLP-powered linter for prose
• Introducing Vale Server. Vale Server is a desktop application | by Joseph Kato
• Testing your Documentation
• errata-ai/styles: A collection of pre-packaged, Vale-compatible style guides ready to be installed from your Vale Server dashboard!

For a transcript of this video, see Transcript: Tag1 TeamTalk #027.3 Documentation as code: Part 3: A Linting How To - The Vale Linter in action (Demo).

Part One | Part Two | Part Three

Photo by Dawid Małecki on Unsplash