We're sorry but this page doesn't work properly without JavaScript enabled. Please enable it to continue.
Feedback

How To Automate Documentation Workflow For Developers

Formal Metadata

Title
How To Automate Documentation Workflow For Developers
Title of Series
Number of Parts
542
Author
License
CC Attribution 2.0 Belgium:
You are free to use, adapt and copy, distribute and transmit the work or content in adapted or unchanged form for any legal purpose as long as the work is attributed to the author in the manner specified by the author or licensor.
Identifiers
Publisher
Release Date
Language

Content Metadata

Subject Area
Genre
Abstract
Many teams want to have quality documentation, but often fail to keep their docs up-to-date. Maintaining docs can be a frustrating and tedious for smaller teams. In this talk, we are going to explore how we can use a CI/CD workflow to encourage teams to write and maintain documentation. I will demonstrate how tools such as Github actions and Vale can improve the quality and readability of documentation in the fraction of the time needed teams usually need to produce docs. In this talk I will discuss: - the importance of quality docs - how to ensure that your docs maintain a consistent writing style - how to maintain you docs using Vale and Github actions