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

Formale Metadaten

Titel
How To Automate Documentation Workflow For Developers
Serientitel
Anzahl der Teile
542
Autor
Lizenz
CC-Namensnennung 2.0 Belgien:
Sie dürfen das Werk bzw. den Inhalt zu jedem legalen Zweck nutzen, verändern und in unveränderter oder veränderter Form vervielfältigen, verbreiten und öffentlich zugänglich machen, sofern Sie den Namen des Autors/Rechteinhabers in der von ihm festgelegten Weise nennen.
Identifikatoren
Herausgeber
Erscheinungsjahr
Sprache

Inhaltliche Metadaten

Fachgebiet
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