Company knowledge base
A company knowledge base rarely dies for lack of tools. It dies because nobody owns the pages and they quietly go out of date. Here is how to set up a base that has owners, a history and a clear way to change it.
In this article
What to put in first#
- how the company works: teams, who is responsible for what, whom to ask about what;
- policies and processes: time off, purchasing, access, shipping a release;
- product guides for support and sales;
- technical decisions and the reasons behind them;
- answers to the questions newcomers ask most often.
Start with what people ask about most. A good first page is the one you have already pasted a link to in the chat three times.
Structure#
A section is a folder, a page is a markdown file. Splitting by audience works well: "Everyone", "Engineering", "Support", "Sales". In the root, a README with the table of contents.
Every page has an owner#
A CODEOWNERS file in the repository assigns the people responsible for each
section: a change to "Policies" will not slip past the person who owns them.
That gives each page an owner who keeps it from going stale.
Changes go through approval#
Important edits are proposed as pull requests. The section owner and colleagues see the before-and-after diff, comment, approve or request changes. After the merge the change lands in the main branch and stays in the history for good: you can always answer "when and why did this rule change?".
Access#
The base is a private organization repository. Access is granted to teams with roles: read, triage, write, maintain. The organization audit log shows who did what.
Limits worth knowing#
There is no full-text search across all pages yet — you navigate through tables of contents and links. There is no visual editor with macros — pages are written in markdown. There is no real-time co-editing. There are no email notifications — they arrive in the inbox on the site. If you are moving from a wiki tool, the Confluence alternative page covers the differences in detail.
Where to start#
Create an organization, a private "Knowledge base" repository, a README with
a table of contents and a CODEOWNERS file. Ask every team to describe, within
a week, the three questions they get most often — and the base will start
answering real questions straight away. For onboarding material, see the
employee knowledge base page.
Try it on your own task
Create a repository — history, issues and pull requests from day one.
Was this helpful?