- tutorial 6
- doc-detective 4
- docs-as-tests 3
- concept 2
- bash 2
- REST 1
- APIs 1
- docs-as-code 1
- overview 1
- comparison 1
- shell 1
- terminal 1
- scripts 1
- native 1
- environments 1
- development 1
- staging 1
- production 1
- cypress 1
- ci 1
- cd 1
- github 1
- github-actions 1
- cli 1
- code-blocks 1
- innovation-engine 1
- microsoft 1
- azure 1
tutorial
Validate README Commands with Innovation Engine
Maintaining accurate and reliable CLI-based documentation is critical, especially when it comes to installation instructions and READMEs.
Add Docs as Tests to Your CI/CD Pipeline with GitHub Actions
Adding Doc Detective into a CI/CD pipeline to run tests whenever changes occur in a repository is easy and gives you a flexible and powerful tech doc toolchain. In this guide, we’ll walk through setting up a basic Docs as Code pipeline using the venerable Jekyll static site generator, set up some simple doc detective tests, and put together scripts for a CI/CD pipeline using Github Actions to demonstrate how to automatically test your docs off of each update.
Validate a UI with Cypress
Docs as Tests is a strategy for using docs to test a product, validating both that the docs are accurate and that the product is functioning as expected. That’s a great aspiration, but what does it look like in practice?
Validate Commands and Scripts with Doc Detective
We’ve covered how to validate UI procedures and API procedures with Doc Detective, but what about shell commands and scripts? After all, not every procedure is navigating through UIs or making API calls.
Validate an API with Doc Detective
Docs as Tests draws on many of the same principles as test-driven-development and data-driven-development and, as such, is a natural fit for REST API documentation.
Validate a UI with Doc Detective
Docs as Tests is a strategy for using docs to test a product, validating both that the docs are accurate and that the product is functioning as expected. That’s a great aspiration, but what does it look like in practice?
doc-detective
Add Docs as Tests to Your CI/CD Pipeline with GitHub Actions
Adding Doc Detective into a CI/CD pipeline to run tests whenever changes occur in a repository is easy and gives you a flexible and powerful tech doc toolchain. In this guide, we’ll walk through setting up a basic Docs as Code pipeline using the venerable Jekyll static site generator, set up some simple doc detective tests, and put together scripts for a CI/CD pipeline using Github Actions to demonstrate how to automatically test your docs off of each update.
Validate Commands and Scripts with Doc Detective
We’ve covered how to validate UI procedures and API procedures with Doc Detective, but what about shell commands and scripts? After all, not every procedure is navigating through UIs or making API calls.
Validate an API with Doc Detective
Docs as Tests draws on many of the same principles as test-driven-development and data-driven-development and, as such, is a natural fit for REST API documentation.
Validate a UI with Doc Detective
Docs as Tests is a strategy for using docs to test a product, validating both that the docs are accurate and that the product is functioning as expected. That’s a great aspiration, but what does it look like in practice?
docs-as-tests
Docs as Tests: From Development to Production
The Docs as Tests methodology stems from a simple but profound principle: documentation shouldn’t just inform—it should also verify. By treating each piece of documentation as a test case that gets executed against the product, teams can preemptively identify discrepancies and ensure that what users read is what they get.
Docs as Tests vs. Docs as Code
Documentation has the critical role of helping users keep their footing in the storm of continuous releases driven by the iterative nature of modern product development. While many people think of documentation as creating guides and references for new features, publishing them online, and moving on to the next feature, this simply doesn’t reflect the actual challenges of technical writing in the age of continuous deployment, agile development, continuous contact, and easy access to feedback from customers. Writing is a big part of docs, of course, but maintaining those docs slides into the background as the business, product, and audience shift around them.
Docs as Tests: A strategy for resilient docs
It’s a common problem: A user is reading the docs for a product, and they come across a step that doesn’t work. Maybe the UI has changed, or the API has been updated, or the instructions are just plain wrong. Whatever the reason, they’re stuck. They can’t move forward, and they can’t get help because the docs are out of date.
concept
Docs as Tests vs. Docs as Code
Documentation has the critical role of helping users keep their footing in the storm of continuous releases driven by the iterative nature of modern product development. While many people think of documentation as creating guides and references for new features, publishing them online, and moving on to the next feature, this simply doesn’t reflect the actual challenges of technical writing in the age of continuous deployment, agile development, continuous contact, and easy access to feedback from customers. Writing is a big part of docs, of course, but maintaining those docs slides into the background as the business, product, and audience shift around them.
Docs as Tests: A strategy for resilient docs
It’s a common problem: A user is reading the docs for a product, and they come across a step that doesn’t work. Maybe the UI has changed, or the API has been updated, or the instructions are just plain wrong. Whatever the reason, they’re stuck. They can’t move forward, and they can’t get help because the docs are out of date.
bash
Validate README Commands with Innovation Engine
Maintaining accurate and reliable CLI-based documentation is critical, especially when it comes to installation instructions and READMEs.
Validate Commands and Scripts with Doc Detective
We’ve covered how to validate UI procedures and API procedures with Doc Detective, but what about shell commands and scripts? After all, not every procedure is navigating through UIs or making API calls.
REST
Validate an API with Doc Detective
Docs as Tests draws on many of the same principles as test-driven-development and data-driven-development and, as such, is a natural fit for REST API documentation.
APIs
Validate an API with Doc Detective
Docs as Tests draws on many of the same principles as test-driven-development and data-driven-development and, as such, is a natural fit for REST API documentation.
docs-as-code
Docs as Tests vs. Docs as Code
Documentation has the critical role of helping users keep their footing in the storm of continuous releases driven by the iterative nature of modern product development. While many people think of documentation as creating guides and references for new features, publishing them online, and moving on to the next feature, this simply doesn’t reflect the actual challenges of technical writing in the age of continuous deployment, agile development, continuous contact, and easy access to feedback from customers. Writing is a big part of docs, of course, but maintaining those docs slides into the background as the business, product, and audience shift around them.
overview
Docs as Tests vs. Docs as Code
Documentation has the critical role of helping users keep their footing in the storm of continuous releases driven by the iterative nature of modern product development. While many people think of documentation as creating guides and references for new features, publishing them online, and moving on to the next feature, this simply doesn’t reflect the actual challenges of technical writing in the age of continuous deployment, agile development, continuous contact, and easy access to feedback from customers. Writing is a big part of docs, of course, but maintaining those docs slides into the background as the business, product, and audience shift around them.
comparison
Docs as Tests vs. Docs as Code
Documentation has the critical role of helping users keep their footing in the storm of continuous releases driven by the iterative nature of modern product development. While many people think of documentation as creating guides and references for new features, publishing them online, and moving on to the next feature, this simply doesn’t reflect the actual challenges of technical writing in the age of continuous deployment, agile development, continuous contact, and easy access to feedback from customers. Writing is a big part of docs, of course, but maintaining those docs slides into the background as the business, product, and audience shift around them.
shell
Validate Commands and Scripts with Doc Detective
We’ve covered how to validate UI procedures and API procedures with Doc Detective, but what about shell commands and scripts? After all, not every procedure is navigating through UIs or making API calls.
terminal
Validate Commands and Scripts with Doc Detective
We’ve covered how to validate UI procedures and API procedures with Doc Detective, but what about shell commands and scripts? After all, not every procedure is navigating through UIs or making API calls.
scripts
Validate Commands and Scripts with Doc Detective
We’ve covered how to validate UI procedures and API procedures with Doc Detective, but what about shell commands and scripts? After all, not every procedure is navigating through UIs or making API calls.
native
Validate Commands and Scripts with Doc Detective
We’ve covered how to validate UI procedures and API procedures with Doc Detective, but what about shell commands and scripts? After all, not every procedure is navigating through UIs or making API calls.
environments
Docs as Tests: From Development to Production
The Docs as Tests methodology stems from a simple but profound principle: documentation shouldn’t just inform—it should also verify. By treating each piece of documentation as a test case that gets executed against the product, teams can preemptively identify discrepancies and ensure that what users read is what they get.
development
Docs as Tests: From Development to Production
The Docs as Tests methodology stems from a simple but profound principle: documentation shouldn’t just inform—it should also verify. By treating each piece of documentation as a test case that gets executed against the product, teams can preemptively identify discrepancies and ensure that what users read is what they get.
staging
Docs as Tests: From Development to Production
The Docs as Tests methodology stems from a simple but profound principle: documentation shouldn’t just inform—it should also verify. By treating each piece of documentation as a test case that gets executed against the product, teams can preemptively identify discrepancies and ensure that what users read is what they get.
production
Docs as Tests: From Development to Production
The Docs as Tests methodology stems from a simple but profound principle: documentation shouldn’t just inform—it should also verify. By treating each piece of documentation as a test case that gets executed against the product, teams can preemptively identify discrepancies and ensure that what users read is what they get.
cypress
Validate a UI with Cypress
Docs as Tests is a strategy for using docs to test a product, validating both that the docs are accurate and that the product is functioning as expected. That’s a great aspiration, but what does it look like in practice?
ci
Add Docs as Tests to Your CI/CD Pipeline with GitHub Actions
Adding Doc Detective into a CI/CD pipeline to run tests whenever changes occur in a repository is easy and gives you a flexible and powerful tech doc toolchain. In this guide, we’ll walk through setting up a basic Docs as Code pipeline using the venerable Jekyll static site generator, set up some simple doc detective tests, and put together scripts for a CI/CD pipeline using Github Actions to demonstrate how to automatically test your docs off of each update.
cd
Add Docs as Tests to Your CI/CD Pipeline with GitHub Actions
Adding Doc Detective into a CI/CD pipeline to run tests whenever changes occur in a repository is easy and gives you a flexible and powerful tech doc toolchain. In this guide, we’ll walk through setting up a basic Docs as Code pipeline using the venerable Jekyll static site generator, set up some simple doc detective tests, and put together scripts for a CI/CD pipeline using Github Actions to demonstrate how to automatically test your docs off of each update.
github
Add Docs as Tests to Your CI/CD Pipeline with GitHub Actions
Adding Doc Detective into a CI/CD pipeline to run tests whenever changes occur in a repository is easy and gives you a flexible and powerful tech doc toolchain. In this guide, we’ll walk through setting up a basic Docs as Code pipeline using the venerable Jekyll static site generator, set up some simple doc detective tests, and put together scripts for a CI/CD pipeline using Github Actions to demonstrate how to automatically test your docs off of each update.
github-actions
Add Docs as Tests to Your CI/CD Pipeline with GitHub Actions
Adding Doc Detective into a CI/CD pipeline to run tests whenever changes occur in a repository is easy and gives you a flexible and powerful tech doc toolchain. In this guide, we’ll walk through setting up a basic Docs as Code pipeline using the venerable Jekyll static site generator, set up some simple doc detective tests, and put together scripts for a CI/CD pipeline using Github Actions to demonstrate how to automatically test your docs off of each update.
cli
Validate README Commands with Innovation Engine
Maintaining accurate and reliable CLI-based documentation is critical, especially when it comes to installation instructions and READMEs.
code-blocks
Validate README Commands with Innovation Engine
Maintaining accurate and reliable CLI-based documentation is critical, especially when it comes to installation instructions and READMEs.
innovation-engine
Validate README Commands with Innovation Engine
Maintaining accurate and reliable CLI-based documentation is critical, especially when it comes to installation instructions and READMEs.
microsoft
Validate README Commands with Innovation Engine
Maintaining accurate and reliable CLI-based documentation is critical, especially when it comes to installation instructions and READMEs.
azure
Validate README Commands with Innovation Engine
Maintaining accurate and reliable CLI-based documentation is critical, especially when it comes to installation instructions and READMEs.