Brussels / 4 & 5 February 2023


How To Automate Documentation Workflow For Developers

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


Photo of Portia Burton Portia Burton