Sign-In
Cart
Docs as Tests: A Strategy for Resilient Technical Documentation
Paperback
Please select the version of book you would like to purchase.
ISBN10: 0994169361
ISBN13: 9780994169365
Publisher: Boffin Education
Published: Apr 18 2025
Pages: 220
Weight: 0.51
Height: 0.46 Width: 5.25 Depth: 8.00
Language: English
ISBN13: 9780994169365
Publisher: Boffin Education
Published: Apr 18 2025
Pages: 220
Weight: 0.51
Height: 0.46 Width: 5.25 Depth: 8.00
Language: English
Have you ever discovered that your documentation was wrong-only after a user reported it? Keeping documentation accurate is a constant battle-especially when products change rapidly. Docs as Tests introduces a game-changing approach: treating documentation as part of the testing process. By automating documentation validation, you can make sure that every guide, API reference, and code snippet stays correct as your product evolves. Manny Silva has spent over fifteen years working with companies like Apple, Google, and Skyflow to improve technical documentation. Frustrated by the struggle to keep docs in sync with fast-moving products, he pioneered the Docs as Tests strategy and built Doc Detective, an open-source tool for automated documentation validation. Now, he shares his expertise to help teams future-proof their documentation. What You'll Learn:
- Why documentation errors happen-and how to prevent them before users notice.
- How to automate the testing of UI docs, API references, and code examples.
- Practical strategies for integrating documentation testing into your development workflow.
- Best practices for keeping documentation and products in sync, even in fast-moving environments.
Who This Book Is For:
Carlos Evia, Professor and Chief Technology Officer; CLAHS, Virginia Tech If your docs aren't tested, they're one code change away from being wrong. This book is all about turning documentation from a static resource into a living, tested asset. If you've ever struggled with outdated docs, you need this.
Jake Cahill, Senior Principal Technical Writer at Redpanda Data Docs as Tests transformed the way I approach writing, maintaining, and evangelizing documentation. With this approach, you can give your users confidence that your documentation reflects the current state of your products and APIs. This confidence builds the trust that's essential for adoption and success.
Sarah Sanders, Technical Writer at Docker Docs as Tests weaves a rich tapestry of ideas around documentation as a source of truth, and testing as a source of confidence. Investing in more accurate docs builds user trust, and therefore makes your product more valuable. Every team will find something in this book that they can adopt to improve their docs.
Lorna Mitchell, OpenAPI Initiative The techniques in this book help technical writers and developers create reliable, up-to-date documentation that evolves alongside production code. I learned a lot while reading this book, and I plan to prioritize test creation in my documentation projects.
Anne Gentle, Consultant, Just Write Click Great products deserve great docs-but too often they're built in isolation. Manny Silva lays out a clear, actionable path to bring them together. If you're ready to close the gap, start with this book.
-Adam Altman, Founder of Redocly
- Technical writers looking to keep documentation accurate despite frequent product updates.
- Developers and engineers who contribute to docs and want reliable ways to verify them.
- Product managers who understand the role of docs in adoption and user success.
- QA professionals interested in extending testing frameworks to documentation.
Carlos Evia, Professor and Chief Technology Officer; CLAHS, Virginia Tech If your docs aren't tested, they're one code change away from being wrong. This book is all about turning documentation from a static resource into a living, tested asset. If you've ever struggled with outdated docs, you need this.
Jake Cahill, Senior Principal Technical Writer at Redpanda Data Docs as Tests transformed the way I approach writing, maintaining, and evangelizing documentation. With this approach, you can give your users confidence that your documentation reflects the current state of your products and APIs. This confidence builds the trust that's essential for adoption and success.
Sarah Sanders, Technical Writer at Docker Docs as Tests weaves a rich tapestry of ideas around documentation as a source of truth, and testing as a source of confidence. Investing in more accurate docs builds user trust, and therefore makes your product more valuable. Every team will find something in this book that they can adopt to improve their docs.
Lorna Mitchell, OpenAPI Initiative The techniques in this book help technical writers and developers create reliable, up-to-date documentation that evolves alongside production code. I learned a lot while reading this book, and I plan to prioritize test creation in my documentation projects.
Anne Gentle, Consultant, Just Write Click Great products deserve great docs-but too often they're built in isolation. Manny Silva lays out a clear, actionable path to bring them together. If you're ready to close the gap, start with this book.
-Adam Altman, Founder of Redocly
Also in
Technology & Engineering
Improvised Munitions Black Book: Complete and Unabridged in One Volume: Complete and Unabridged in One Volume
U S Government
Paperback
$18.99
Off-Grid Solar Power Made Easy: Design and Installation of Photovoltaic system For Rvs, Vans, Cabins, Boats and Tiny Homes
Jordan, William
Hardcover
$37.49
The New Age of Sexism: How AI and Emerging Technologies Are Reinventing Misogyny
Bates, Laura
Hardcover
$26.09
Musashi's Book of Five Rings: The Definitive Interpretation of Miyamoto Musashi's Classic Book of Strategy
Musashi, Miyamoto
Kaufman, Stephen F.
Paperback
$13.25
The Problem with Plastic: How We Can Save Ourselves and Our Planet Before It's Too Late
Mahoney, Adam
Beyond Plastics
Enck, Judith
Hardcover
$25.19
Rocket Dreams: Musk, Bezos, and the Inside Story of the New, Trillion-Dollar Space Race
Davenport, Christian
Hardcover
$30.40
The Home Blacksmith: Tools, Techniques, and 40 Practical Projects for the Home Blacksmith
Ridgway, Ryan
Paperback
$18.99
ASE Technician Test Preparation Automotive Maintenance and Light Repair (G1)
Delmar Cengage Learning
Paperback
$49.23
AI Snake Oil: What Artificial Intelligence Can Do, What It Can't, and How to Tell the Difference
Kapoor, Sayash
Narayanan, Arvind
Hardcover
$23.70
Midnight in Chernobyl: The Untold Story of the World's Greatest Nuclear Disaster
Higginbotham, Adam
Paperback
$20.89
Atlas of AI: Power, Politics, and the Planetary Costs of Artificial Intelligence
Crawford, Kate
Paperback
$19.00
CNC Woodworking for the Absolute Beginner: Winning Tips, Techniques & 5 Skill-Building Projects
Bagnall, Ralph
Paperback
$12.34
The Trillion Dollar War Machine: How Runaway Military Spending Drives America Into Foreign Wars and Bankrupts Us at Home
Freeman, Ben
Hartung, William D.
Hardcover
$27.00
The Fourth Intelligence Revolution: The Future of Espionage and the Battle to Save America
Vinci, Anthony
Hardcover
$29.44
Broken Money: Why Our Financial System is Failing Us and How We Can Make it Better
Alden, Lyn
Paperback
$22.79
The Pacific Circuit: A Globalized Account of the Battle for the Soul of an American City
Madrigal, Alexis
Hardcover
$28.80
The Baofeng Radio Revolution: The Beginner Guerrilla's Guide to Break Through the Complexity, Secure Communications, and Prepare for Disaster With Pre
Code Publishing, Morse
Hardcover
$28.49
Agentic Artificial Intelligence: Harnessing AI Agents to Reinvent Business, Work, and Life
Wirtz, Jochen
Davenport, Thomas H.
Bornet
Paperback
$27.54
Pilot's Handbook of Aeronautical Knowledge (2025): Faa-H-8083-25c
Federal Aviation Administration (FAA)
Paperback
$23.74
The Unaccountability Machine: Why Big Systems Make Terrible Decisions--And How the World Lost Its Mind
Davies, Dan
Paperback
$19.00
The Big Hop: The First Non-Stop Flight Across the Atlantic Ocean and Into the Future
Rooney, David
Hardcover
$26.99
The Coming Wave: Technology, Power, and the Twenty-First Century's Greatest Dilemma
Suleyman, Mustafa
Hardcover
From $12.99
Engineering in Plain Sight: An Illustrated Field Guide to the Constructed Environment
Hillhouse, Grady
Hardcover
$37.99
AI Snake Oil: What Artificial Intelligence Can Do, What It Can't, and How to Tell the Difference
Narayanan, Arvind
Kapoor, Sayash
Paperback
$16.10
Tubes: A Journey to the Center of the Internet with a New Introduction by the Author
Blum, Andrew
Paperback
$19.99
Artificial Intelligence: A Guide for Thinking Humans (with a New Preface)
Mitchell, Melanie
Paperback
$19.00
The Cybernetic Society: How Humans and Machines Will Shape the Future Together
Husain, Amir
Hardcover
$28.50
The Book of Five Rings: Including the Book of Family Traditions on the Art of War by Yagyu Munenori
Musashi, Miyamoto
Paperback
$9.49
Adventures on the Wine Route: A Wine Buyer's Tour of France (25th Anniversary Edition)
Lynch, Kermit
Paperback
$20.90
Beast in the Machine: How Robotics and AI Will Transform Warfare and the Future of Human Conflict
Dougherty, George M.
Hardcover
$28.45
The Elements of Power: A Story of War, Technology, and the Dirtiest Supply Chain on Earth
Niarchos, Nicolas
Hardcover
$30.40
What Is Intelligence?: Lessons from AI about Evolution, Computing, and Minds
Aguera Y. Arcas, Blaise
Paperback
$35.10
The Natural Dye Handbook: A Comprehensive Guide to Dyeing with Plants for Beginners and Beyond
Iverson, Heidi
Hardcover
$25.64
Power and Progress: Our Thousand-Year Struggle Over Technology and Prosperity
Johnson, Simon
Acemoglu, Daron
Paperback
$20.89
Basic Butchering of Livestock & Game: Beef, Veal, Pork, Lamb, Poultry, Rabbit, Venison
Mettler, John J.
Paperback
$17.09
Agentic Artificial Intelligence: Harnessing AI Agents to Reinvent Business, Work, and Life
Bornet, Pascal
Wirtz, Jochen
Davenport, Thomas H.
Hardcover
$32.99
Pilot's Handbook of Aeronautical Knowledge: Faa-H-8083-25c
Federal Aviation Administration (FAA)
Hardcover
$47.49
Trapped Under the Sea: One Engineering Marvel, Five Men, and a Disaster Ten Miles Into the Darkness
Swidey, Neil
Paperback
$22.00
The Body Digital: A Brief History of Humans and Machines from Cuckoo Clocks to ChatGPT
Chang, Vanessa
Paperback
$17.99
Longitude: The True Story of a Lone Genius Who Solved the Greatest Scientific Problem of His Time
Sobel, Dava
Paperback
$17.09
Genesis: Artificial Intelligence, Hope, and the Human Spirit
Mundie, Craig
Kissinger, Henry a.
Schmidt, Eric
Hardcover
$27.00
The Magic of Code: How Digital Language Created and Connects Our World--And Shapes Our Future
Arbesman, Samuel
Hardcover
$27.00
Rad Future: The Untold Story of Nuclear Electricity and How It Will Save the World
Boemeke, Isabelle
Hardcover
$28.50
The Color of North: The Molecular Language of Proteins and the Future of Life
Rizk, Shahir S.
Fink, Maggie M.
Hardcover
$25.16
The Boy Who Harnessed the Wind: Creating Currents of Electricity and Hope
Kamkwamba, William
Mealer, Bryan
Paperback
From $9.99
Cadillac Desert: The American West and Its Disappearing Water, Revised Edition
Reisner, Marc
Paperback
$19.95
Make: Electronics: Learning by Discovery: A Hands-On Primer for the New Electronics Enthusiast
Platt, Charles
Paperback
$33.24
Guía práctica en gestión de proyectos: Aprende a aplicar las técnicas de gestión de proyectos a proyectos reales
Garriga Rodriguez, Albert
Paperback
$17.16
Essential Electric Circuits: Analysis and Design with Practical Considerations and Applications
Hanselman, Duane
Paperback
$62.50
The Wildcrafting Brewer: Creating Unique Drinks and Boozy Concoctions from Nature's Ingredients
Baudar, Pascal
Paperback
$28.45
Chassis Engineering: Chassis Design, Building & Tuning for High Performance Cars
Adams, Herb
Paperback
$33.25
Designing for People: An Introduction to Human Factors Engineering
Liu, Yili
Boyle, Linda Ng
Wickens, Christopher D.
Paperback
$93.60
Bringing Columbia Home: The Untold Story of a Lost Space Shuttle and Her Crew
Ward, Jonathan H.
Leinbach, Michael D.
Paperback
$18.04
Deadliest Sea: The Untold Story Behind the Greatest Rescue in Coast Guard History
Thompson, Kalee
Paperback
From $7.99
AI for Business: The Beginner's Fast Track to ChatGPT for Productivity, Profit, and Growth (2 books in 1)
Grant, Russel
Paperback
$25.64
U.S. Army Special Forces Guide to Unconventional Warfare: Devices and Techniques for Incendiaries
Army
United States Department of the Army
Paperback
$12.34
Energy-Based Safety: A Scientific Approach to Preventing Serious Injuries and Fatalities (Sifs)
Hallowell, Matthew R.
Hardcover
$154.00
Texas DMV Driver's Handbook: Practice for the Texas Permit Test with 350+ Driving Questions and Answers
Prep, Discover
Paperback
$10.35
forgot password: A great book to keep all confidential info handy for websites/usernames/passwords with tabs alphabetical A-Z
Henderson, Maya Lp
Paperback
$7.14
Introduction to Live Sound Reinforcement: The Science, the Art, and the Practice
Boyce, Teddy
Paperback
$37.99
The Lost Subways of North America: A Cartographic Guide to the Past, Present, and What Might Have Been
Berman, Jake
Hardcover
$33.25
Grid Systems in Graphic Design: A Visual Communication Manual for Graphic Designers, Typographers and Three Dimensional Designers
Müller-Brockmann, Josef
Hardcover
$56.95