remixtures, 4 months ago Portuguese

#TechnicalWriting #SoftwareDocumentation #SoftwareTesting #DocsAsTests #APIDocumentation: "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/