Documentation Systems Explained
Documentation systems: wikis for collaborative linked knowledge, README hierarchy from project to file level, and docs-as-code with version control.
Page Summary
An explainer of documentation systems, opening with GitLab running the whole company through a public 2,000-page handbook that let new hires self-answer 90% of questions. It covers what makes a system effective (the four pillars of documentation architecture, organizing for user intent), compares wiki-style, docs-as-code, and hybrid approaches, explains why documentation decays and strategies for sustainable maintenance, designing for discovery through search and information architecture, choosing what to document with a priority matrix, and building a documentation culture.
Contributions
Every accepted correction to this page is recorded with the exact change, so readers can see how the page improved over time.
-
The 19% figure is from McKinsey Global Institute's 2012 'The Social Economy' report, as the article's own reference list confirms
BeforeA 2021 study by McKinsey estimated that knowledge workers spend 19% of their workweek
AfterA 2012 study by McKinsey estimated that knowledge workers spend 19% of their workweek
Why: Verified live: body content already correctly cites the 2012 McKinsey study. FAQ, excerpt, meta_description, and seo_keywords contain no reference to this statistic, so no residual fabrication anywhere on the post.
View the full record →