A Documentation Writing Workshop is a collaborative session where multiple contributors improve or create system documentation together. It's especially useful after releasing new tokens, patterns, or templates, or when existing docs feel outdated. By bringing roles together, you build shared ownership of content, ensure consistency, and reduce bottlenecks on a single writer.
How to
-
Form a group Invite a mix of designers, developers, and content specialists. Aim for 3–5 people for focus.
-
Pick the scope Choose one or two pages or sections that need the most work, such as a guidance page or a new pattern spec.
-
Assign roles Agree who will draft, review, or bring an accessibility perspective. Rotate these roles to build shared skill.
-
Write and review live Pair on sections directly, using screensharing or shared docs. Capture examples, visuals, and annotations as you go.
-
Test with someone new Run Guidance Clarity with someone unfamiliar with the pattern or page review the draft for clarity. Adjust wording and visuals based on their feedback.
-
Publish to guidance Push the updated content into your Guidance Setup so it's instantly available to teams.