Version control

Using Git as a tool to version control documentation gives us complete transparency and control over content updates.

When developing documentation as code, we generally store our document as a Git repository.

Git tracks every update made to content within a repository via commits. We can tag the document at a specific time manually to version it, or rely on Git flows to analyze document changes.

This approach proves scalable - even when we have dozens of collaborators working on the same content across a decentralized team. We can apply permissions to what user can update what branch, and whether a gatekeeper needs to approve a change.

Define workflows to update tags manually via your company's specific documentation workflows and included or referenced in the README.md file of your document.

The below example shows a document lifecycle tool (GitLab in this case) and its tag function.

Example

See also