The Docs as Code Primer
The Docs as Code Primer
A practical handbook
About the Book
The Docs as Code Primer: A practical handbook is a "must read" to get you started by implementing Docs as Code for developers, DevOps Engineers and solution architect. The book is packed with a ton of practical examples and tools you can use to accelerate your writing in the technical documentation domain. The reader should have a basic understanding:
- Plaintext markup languages
- CI/CD practices
- Version control
- Scripting Languages (e.g., PowerShell, Bash)
The book is divided into seven chapters:
- Introduction to Docs as Code
- Getting started
- Documentation architecture
- Building documentation
- Testing
- Integrating in CI/CD Pipelines
- Automation
After reading this book, you will have learned the following:
- What tools and technologies are available to write effective technical documentation
- How to enforce standards and consistency across documentation
- How to catch invalid documents
- How to perform proper testing with CLI utilities
- How to build documentation and expose it to the public or internal
- How to implement proper CI/CD for documentation
- How to automate for other platforms and use tools to generate other output formats while keeping a single point of truth
- Which AI tool can help you to accelerate your technical writing directly from the editor
About the Author
Table of Contents
- Foreword
- Introduction
- Who should read this book?
- What to expect from this book?
- How has the content of this book been structured?
- About the Author
- Chapter 1 - Introduction to Docs as Code
- Introduction
- What is Docs as Code?
- Why Docs as Code?
- History of Docs as Code
- Summary
- Chapter 2 - Getting started
- Introduction
- Visual Studio Code as Markdown editor
- Manually installing VSCode
- Automatically installing VSCode
- Using VSCode extensions
- Markdownlint
- Code Spell Checker
- Markdown tables and images
- Summary
- Chapter 3 - Documentation architecture
- Introduction
- Have Version Control System ready
- Documentation source file types
- Documentation generators
- Continuous Integration
- Automated testing
- Collaboration tools
- Style guide and documentation standards
- Metadata Management
- Summary
- Chapter 4 - Building documentation
- Introduction
- Using MkDocs
- Building the project
- Considerations
- Summary
- Chapter 5 - Testing
- Introduction
- The Markdownlint CLI
- Run Code Spell Checker from CLI
- Format Markdown table testing
- Testing external links
- One script to rule them all
- Bonus round - Pre-commit hook
- Summary
- Chapter 6 - Integrating in CICD Pipelines
- Introduction
- The build stage
- Testing through pipeline
- Publishing
- Summary
- Chapter 7 - Automation
- Introduction
- Use case 1 - Pandoc
- Use case 2 - Confluence
- Use case 3 - DocFx
- Use case 4 - AI Grammar Checker and Paraphrasing
- Summary
- Appendix A: Azure DevOps
- Working with identifiers
- Appendix B: Azure resources
- Creating Azure resources
- Recommended Reading
- Final note
- Release notes
The Leanpub 60 Day 100% Happiness Guarantee
Within 60 days of purchase you can get a 100% refund on any Leanpub purchase, in two clicks.
Now, this is technically risky for us, since you'll have the book or course files either way. But we're so confident in our products and services, and in our authors and readers, that we're happy to offer a full money back guarantee for everything we sell.
You can only find out how good something is by trying it, and because of our 100% money back guarantee there's literally no risk to do so!
So, there's no reason not to click the Add to Cart button, is there?
See full terms...
80% Royalties. Earn $16 on a $20 book.
We pay 80% royalties. That's not a typo: you earn $16 on a $20 sale. If we sell 5000 non-refunded copies of your book or course for $20, you'll earn $80,000.
(Yes, some authors have already earned much more than that on Leanpub.)
In fact, authors have earnedover $13 millionwriting, publishing and selling on Leanpub.
Learn more about writing on Leanpub
Free Updates. DRM Free.
If you buy a Leanpub book, you get free updates for as long as the author updates the book! Many authors use Leanpub to publish their books in-progress, while they are writing them. All readers get free updates, regardless of when they bought the book or how much they paid (including free).
Most Leanpub books are available in PDF (for computers) and EPUB (for phones, tablets and Kindle). The formats that a book includes are shown at the top right corner of this page.
Finally, Leanpub books don't have any DRM copy-protection nonsense, so you can easily read them on any supported device.
Learn more about Leanpub's ebook formats and where to read them
