remixtures, to TechnicalWriting Portuguese
@remixtures@tldr.nettime.org avatar

: "I wrote last month about how to test docs code examples. Now, let’s look at what to test in docs code examples.

  • Test the claims you make in docs
  • Use the APIs you document
  • Demonstrate common usage patterns and best practices
  • Figure out where you can safely omit boilerplate code

There are also a couple of “don’ts” when writing and testing docs code examples:

  • Don’t show “wrong” code
  • Don’t recreate comprehensive engineering tests for edge cases"

https://dacharycarey.com/2024/02/11/what-to-test-in-docs-code-examples/

remixtures, to TechnicalWriting Portuguese
@remixtures@tldr.nettime.org avatar

: "I initially developed and implemented Docs as Tests at Skyflow, a startup that moves fast and releases features and updates even faster than I’d experienced before. I searched for tools to help me manage the pace of changes: there were style linters, API testers, and engineering-focused testing tools, but there wasn’t anything to easily help me validate the product descriptions or procedures in my docs. So I built my own, and Doc Detective was born. Doc Detective is a toolkit that parses docs and runs tests (like stepping through procedures) directly against UIs and APIs. It’s designed so non-engineers can use it individually, but teams can also collaborate. When I set it up to test my docs, it caught issues that I had no idea of. It was a game-changer.

But Doc Detective is just a tool (a good one, I like to think!), and no tool solves every problem. I wanted to find a way to apply my learnings to the broader docs community, and I came up with Docs as Tests—a strategy that can be implemented with whichever tools you choose to validate your docs. I’m excited to share my learnings with you and to learn from you as well."

https://www.docsastests.com/docs-as-tests/concept/2024/01/09/intro-docs-as-tests.html

  • All
  • Subscribed
  • Moderated
  • Favorites
  • JUstTest
  • tacticalgear
  • DreamBathrooms
  • thenastyranch
  • magazineikmin
  • Durango
  • cubers
  • Youngstown
  • mdbf
  • slotface
  • rosin
  • ngwrru68w68
  • kavyap
  • GTA5RPClips
  • provamag3
  • ethstaker
  • InstantRegret
  • Leos
  • normalnudes
  • everett
  • khanakhh
  • osvaldo12
  • cisconetworking
  • modclub
  • anitta
  • tester
  • megavids
  • lostlight
  • All magazines