Write Better with Vale (Pragmatic Bookshelf)

PragmaticBookshelf
Brian P. Hogan @bphogan
edited by Susannah Davidson @susannahd
Create consistent content that gives readers confidence with Vale, the open-source prose linter that helps you enforce your style guide automatically. Use battle-tested rules based on freely available, popular style guides, apply your brand’s terms with a custom vocabulary, and integrate Vale into your text editor, Git hooks, and CI pipeline. Catch typos and inclusive-language issues before they ship, and spend your energy on shaping ideas instead of fixing copy. Whether you’re a technical writer working in a docs-as-code environment, or a software engineer who occasionally writes, you’ll ship clean, consistent copy every time.
When you work on a content project, keeping things consistent can feel impossible. Typos slip through, people don’t follow style rules, and each contributor brings a slightly different voice. Vale helps you ensure consistency across your content.
You’ll start by catching typos as you learn how Vale works through hands-on examples. Then you’ll bring in community rules based on Google’s and Microsoft’s style guides. You’ll combine overlapping styles, adjust the rules to match your needs, and start shaping the experience you want readers to have. Then you’ll build your own rules from scratch and create a custom vocabulary to teach Vale to enforce your team’s voice and jargon. By the end, you’ll have a fully integrated, reusable style package that works in your editor, GitHub Actions, and your build systems. And while this book uses Markdown in its examples, you’ll be ready to apply everything you learned to reStructuredText, AsciiDoc, and even the comments in your source code.
Vale gives you a fast, reliable, and customizable way to keep your content consistent.
Brian P. Hogan is a technical content expert, open source software developer, educator, author, editor, and musician with more than 15 years of experience developing and leading technical documentation and developer education programs at DigitalOcean, Temporal Technologies, and Tailscale.
-
Full details: Write Better with Vale: Automate Your Style Guides and Lint Prose Like You Lint Code by Brian P. Hogan
View this book’s portal and details on how to post errata and suggestions here.
Don’t forget you can get 35% off with your Devtalk discount! Just use the coupon code “devtalk.com" at checkout
Latest Threads About This Book

Most Active This Week

Most Active This Month
Most Active This Year
Most Active Last Three Years
Most Active Over Three Years
Latest in Write Better with Vale
Get money off!

The Pragmatic Bookshelf
35% off any eBook
Use the coupon code "devtalk.com" to get 35% off any eBook published by PragProg!
Filter by Type:
Related Portals
-
None added yet