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:

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.

If you care about keeping your documentation accurate and reliable, this book will show you how.

Praise for This Book

“Docs as Tests brings documentation to life. Discover how tests can adapt to your specific documentation needs (start with a cupcake) before diving into advanced workflows (a whole wedding cake). This resource is easy to read and informative for both practitioners and students of modern technical writing.”
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

« Synopsis » peut appartenir à une autre édition de cet ouvrage.

ThriftBooks-Atlanta

AUSTELL, GA, Etats-Unis

Vendeur avec une évaluation de 5 étoiles

Vendeur AbeBooks depuis 24 mars 2009

Frais d'expédition à l'intérieur de ce pays : Etats-Unis

Article	4 à 8 jours ouvrés	4 à 8 jours ouvrés
Premier article	EUR 0,00	EUR 0,00

Les délais de livraison sont fixés par les vendeurs et varient en fonction du transporteur et du lieu. Les commandes transitant par les douanes peuvent être retardées et les acheteurs sont responsables de tous les droits ou frais associés. Les vendeurs peuvent vous contacter au sujet de frais supplémentaires afin de couvrir toute augmentation des coûts d'expédition de vos articles.

Modes de paiement

Description de la boutique

ThriftBooks is a fully independent seller of used books, having sold more than 160 million used and new books since we started in 2003. Each quality used book is sorted, graded, shelved and shipped by hand by our team of dedicated employees in our seven warehouses across the US. We have the best selection of books, in the right condition and format, at everyday low prices. We also have a dedicated, US-based Customer Service team, ranked in the top three by Newsweek for Best Customer Service in 2018 and 2019, so you can shop with confidence. We support and invest in our employees, appreciate and value our customers, and truly believe in the power of the written word to educate, energize, and engage readers of all ages and interests.…

Profil professionnel du vendeur

Thrift Books Global, LLC

18300 Cascade Ave S, Ste 150
Seattle, WA Etats-Unis 98188

Contacter le vendeurConsulter les articles de ce vendeurAfficher la vitrine du vendeur

Conditions de vente

We guarantee the condition of every book as it's described
on the Abebooks website. If you're dissatisfied with your
purchase (Incorrect Book/Not as Described/Damaged) or if the
order hasn't arrived, you're eligible for a refund within 30
days of the estimated delivery date. If you've changed your
mind about a book that you've ordered, please use the "Ask
bookseller a question link to contact us" and we'll respond
as soon as possible.

Droit de rétractation

Si vous êtes un consommateur, vous pouvez exercer votre droit de rétractation sur le contrat conformément à ce qui suit. Le mot « consommateur » désigne toute personne physique agissant à des fins qui n'entrent pas dans le cadre de son activité commerciale, artisanale ou professionnelle.

Informations concernant le droit de rétractation

Droit statutaire de rétractation

Vous avez le droit d'exercer votre droit de rétractation sur ce contrat dans les 14 jours sans donner de raison.

Le délai de rétractation expirera au bout de 14 jours à compter du jour où vous-même, ou un tiers autre que le transporteur et désigné par vous, prendrez physiquement possession de la dernière marchandise, du dernier lot ou de la dernière pièce.

Pour exercer votre droit de rétractation, remplissez électroniquement et envoyez une déclaration claire sur notre site Web, sous « Vos achats » dans « Votre compte ». Nous vous communiquerons sans délai un accusé de réception de cette rétractation sur un support durable (par exemple, par e-mail).

Pour respecter le délai de rétractation, il vous suffit d'envoyer votre message concernant l'exercice de votre droit de rétractation avant l'expiration du délai de rétractation.

Effets de la rétractation

Si vous exercez votre droit de rétractation sur ce contrat, nous vous rembourserons tous les paiements que vous avez effectués, y compris les frais de livraison (à l'exception des frais supplémentaires résultant du choix d'un mode de livraison autre que le type de livraison standard le moins cher que nous proposons).

Nous pouvons déduire du remboursement la perte de valeur de toute marchandise livrée, si la perte est le résultat d'une manipulation inutile de votre part.

Nous effectuerons le remboursement dans les meilleurs délais, et au plus tard 14 jours après le jour où nous aurons été informés de votre décision d'exercer votre droit de rétractation sur ce contrat.

Nous effectuerons le remboursement en utilisant le même moyen de paiement que celui que vous avez utilisé pour la transaction initiale, sauf si vous en avez expressément convenu autrement ; en tout état de cause, aucuns frais ne vous seront facturés à la suite d'un tel remboursement.

Nous pouvons suspendre le remboursement jusqu'à ce que nous ayons reçu les marchandises ou que vous ayez fourni la preuve que vous avez renvoyé les marchandises, en fonction de la première éventualité.

Vous devez renvoyer les marchandises ou les remettre à ThriftBooks-Atlanta, Dallas, Texas, U.S.A., sans retard injustifié et, en tout état de cause, au plus tard 14 jours à compter du jour où vous nous avez communiqué votre décision de rétractation du présent contrat. Le délai est respecté si vous renvoyez les marchandises avant l'expiration du délai de 14 jours. Vous devrez prendre en charge les frais directs du renvoi des marchandises. Vous n'êtes responsable que de toute diminution de valeur des marchandises résultant d'une manipulation autre que celle nécessaire pour établir la nature, les caractéristiques et le fonctionnement des marchandises.

Exceptions au droit de rétractation

Le droit de rétractation ne s'applique pas à ce qui suit :

Distribution de journaux, de revues ou de magazines, à l'exception des contrats d'abonnement ; et
Fourniture d'un contenu numérique qui n'est pas fourni sur un support matériel (par exemple, sur un CD ou un DVD) si vous avez accepté, lors de votre commande, que nous puissions commencer à le livrer et que vous ne puissiez pas exercer votre droit de rétractation une fois la livraison commencée.

Conditions d'expédition

All domestic Standard and Expedited shipments are distributed from our warehouses by OSM, then handed off to the USPS for final delivery.

2-Day Shipping is delivered by FedEx, which does not deliver to PO boxes.

International shipments are tendered to the local postal service in the destination country for final delivery – we do not use courier services for international deliveries.

Docs as Tests: A Strategy for Resilient Technical Documentation

A propos de cet article

Détails bibliographiques

Synopsis