When you want to allow the docs team members to maintain docs within a code repo, while giving the docs team autonomy over their own reviews and merges, you can use a protected branch and a CODEOWNERS file.
Sysdig’s journey from unstructured to structured, and finally, to semi-structured authoring and how Sysdig hackathon enabled designing their homegrown docs-like-code solution.
Techdocs is Spotify’s homegrown docs like code solution. it allows the user to store documentation to near code thus allowing it to be easily discovered.
Review the results of a mid-2020 survey about learning and teaching team mates and yourself how to work with docs like code, Git, and GitHub for technical documentation.
Learn about one team’s journey to keep a long-term relationship with their docs-like-code system, TechDocs, which is open source and available to all.
Welcome to part 4 of our article series, where we take a look under the hood, discuss the technologies we used, how we built our auto-generated API Reference, and how we use GitHub for our docs as code workflow and more.
Learn some pro tips to build Python Sphinx developer docs to both GitHub Pages and your local system.
Welcome to part 3 of our article series where we explore how we collaborate with our community.
Why Redis is joining the revolution of open source docs.
Welcome to part 2 of our article series where we discuss how content production started, and how we created the layouts and navigation for the site.
This article series describes our process for building the platformOS documentation site, with in-depth insights into our approach, decisions, and plans. In this part, we share how we started, how we got to know our audience, how we figured out what content we need, and how we outlined a sitemap for our documentation site.
When faced with tough problems, don’t stop working, try new things, and achieve your docs-as-code dream.
What does it take to publish a technical book using GitHub? Let’s dig into tools, processes, revenue, and costs.
Changing from a content management system to Jekyll and all the change that undertaking took.
In the last three years of Write the Docs conferences, you can learn from others experiences using docs like code techniques.
At Rackspace, we recently modernized our customer documentation, implementing a model that treats documents like code.
From Mandy Whaley’s presentation at All Day DevOps 2017.
Anne Gentle, the original wiki aficionado from the mid-2000s, discusses their relevance today.
Diána Lakatos, a technical writer with developer portal creation specialists Pronovix, explores free and open source API documentation solutions. Her compiled results of the research were originally posted on the Pronovix blog.
Integrating Swagger/OpenAPI files from code with documentation.
Give list pages a makeover using Hugo, a static site generator, with source files on GitHub from Leon Barnard, Designer and Writer at Balsamiq.
Learn how to play and pause animated GIFs on static sites such as Hugo on GitHub from Leon Barnard, Designer and Writer at Balsamiq.
Learn useful techniques for static sites such as Hugo on GitHub from Leon Barnard, Designer and Writer at Balsamiq. He describes documenting multiple versions of a product with a Go-coded solution.
Jennifer Rondeau, Technical Writing Manager at Capital One, talks about her experiences as a Principal Information Developer at Symantec integrating code and documentation tightly.
In this use case, the Technical Content Editor at Pantheon, Rachel Whitton, describes their use of GitHub for documentation on a platform for WordPress and Drupal.
What do you want to know about these techniques?
Make sure you have a punch list of doc bugs to get higher quality results.
Let’s look at a live example.
What do you do when people say, ‘The Docs Suck.’?
When you work with others, your deliverables win.
What would happen if we treated docs like code?