Workflow for Technical Writers
The docs workflow is how documentation changes move from draft to published site using the same tools as developers. Writers use Git branches and pull requests for review, and continuous integration runs builds, link checks and style linters on every change. It also covers keeping versions of docs for product releases and basic localisation for other languages.
Stage: Docs-as-Code and Tooling · Part of the Technical Writer roadmap · Last reviewed 19 November 2026
What to learn in Workflow
- Create a branch, commit a doc change and open a pull request
- Resolve a merge conflict in a Markdown file
- Add a CI job that builds the site and checks for broken links
- Enforce style rules automatically with a prose linter such as Vale
- Maintain versioned docs for multiple product releases
Workflow interview questions
What is docs-as-code?
Docs-as-code treats documentation like source code: plain-text files in a Git repository, reviewed through pull requests, tested by automated checks and deployed by a pipeline. It keeps docs close to the code, supports collaboration with engineers and makes changes traceable.
What does a prose linter like Vale check?
Vale checks text against configurable rules, such as banned words, passive voice, sentence length, product name spelling and heading case. Running it in CI gives consistent style feedback on every pull request, so reviewers can focus on content instead of style.
Where Workflow fits in the Technical Writer roadmap
Workflow belongs to the Docs-as-Code and Tooling stage (beginner level), which takes about 4 hours. Modern doc workflows.
Other units in this stage
Back to the full Technical Writer roadmap