From the course: Creating Technical Documentation with GitHub
Join today to access over 24,400 courses taught by industry experts.
Common problems with traditional documentation - GitHub Tutorial
From the course: Creating Technical Documentation with GitHub
Common problems with traditional documentation
- [Instructor] Common problems with traditional documentation. Traditional documentation often has several challenges compared to the docs as code approach. Here is a breakdown of common problems with traditional documentation and how docs as code addresses them. The first problem is lack of integration with development workflow. And it is divided into two: isolation from code and update delays. For isolation from code, traditional documentation is usually maintained separately from the code base, which can lead to outdated or inconsistent documentation. For update delays, changes in the code may not be immediately reflected in the documentation, causing discrepancies. How does docs as code solve this? Well, in two ways. First, integrated workflow, and the other is continuous updates. With integrated workflows, documentation is stored in the same version control system as the code, ensuring it is up-to-date alongside the code changes. With continuous updates, as code changes…
Download courses and learn on the go
Watch courses on your mobile device without an internet connection. Download courses using your iOS or Android LinkedIn Learning app.
