articles
Protecting a Branch so Only the Docs Team Merges and Publishes
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.
Adopting Docs-as-Code: From Hackathon to Production
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.
Setting up Techdocs on Backstage
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.
Survey results for learning and teaching docs-like-code techniques
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.
Ten tips for maintaining a long-term relationship with docs like code
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.
Building Our Documentation Site on platformOS — Part 4: Implementation
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.
Yes You Can Use GitHub Pages with Python Sphinx
Learn some pro tips to build Python Sphinx developer docs to both GitHub Pages and your local system.
Building Our Documentation Site on platformOS — Part 3: Community
Welcome to part 3 of our article series where we explore how we collaborate with our community.
Redis - Moving to Agile, Open Source Docs
Why Redis is joining the revolution of open source docs.
Building Our Documentation Site on platformOS — Part 2: Content Production and Layouts
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.
Building Our Documentation Site on platformOS — Part 1: Information Architecture
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.
Docs-as-Code: Don’t stop dreaming
When faced with tough problems, don’t stop working, try new things, and achieve your docs-as-code dream.
Practical Advice On Publishing A Technical Book using GitHub and GitBook
What does it take to publish a technical book using GitHub? Let’s dig into tools, processes, revenue, and costs.
Case study: Switching tools to docs-as-code
Changing from a content management system to Jekyll and all the change that undertaking took.
Video Presentations about Docs Like Code
In the last three years of Write the Docs conferences, you can learn from others experiences using docs like code techniques.
Transforming Developer and Support Documentation with Docs Like Code
At Rackspace, we recently modernized our customer documentation, implementing a model that treats documents like code.
DevOps-friendly Docs Publishing for APIs
From Mandy Whaley’s presentation at All Day DevOps 2017.
What about wikis? Content management and change management
Anne Gentle, the original wiki aficionado from the mid-2000s, discusses their relevance today.
Free and Open Source API Documentation Tools - Pronovix, Diána Lakatos
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.
Documenting APIs with Swagger - Lucas Systems, Adam Locke
Integrating Swagger/OpenAPI files from code with documentation.
Lists Get a Makeover - Balsamiq, Leon Barnard
Give list pages a makeover using Hugo, a static site generator, with source files on GitHub from Leon Barnard, Designer and Writer at Balsamiq.
Animated GIFs Pause and Play - Balsamiq, Leon Barnard
Learn how to play and pause animated GIFs on static sites such as Hugo on GitHub from Leon Barnard, Designer and Writer at Balsamiq.
Multiple product versions - Balsamiq, Leon Barnard
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.
Case Study - Symantec, Jennifer Rondeau
Jennifer Rondeau, Technical Writing Manager at Capital One, talks about her experiences as a Principal Information Developer at Symantec integrating code and documentation tightly.
Case Study - Pantheon, Rachel Whitton
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.
Coming Soon - Write Docs Like Code Ebook
What do you want to know about these techniques?
Remodeling documentation
Make sure you have a punch list of doc bugs to get higher quality results.
Building Docs Like Code
Let’s look at a live example.
Quality Tracking with GitHub for Docs
What do you do when people say, ‘The Docs Suck.’?
Collaborating on GitHub for Documentation
When you work with others, your deliverables win.
The Vocabulary of GitHub for Documentation
What would happen if we treated docs like code?