Home
Start at onboarding.
Find how we structure projects under Project Management.
Find task-specific documentation under How we work.
Maintaining the handbook
What should be documented?
Any standard procedures - if there's a "right way" of doing something
Anything we need or do repeatedly
Any best practises - when there's an approach we know generally works better than other options
Who should document something?
The person establishing a standard procedure should document it
The person asking how to do something, when they find it is not documented, or the documentation is out of date or incorrect. They should find out what the current correct information is, and fix the documentation
When do we document something?
We don't have to document everything all at once
We should ideally document standard procedures as that procedure is defined
When we need to carry something out and we've asked someone how to do it, we should document that as part of carrying out the task
How much detail do I need to document?
The documentation should be as concise as possible, while being sufficient so that someone can carry out a task correctly without assistance
Rather than document every detail, document the bits that are specific to us, and link to an online guide to the general approach
How should we organise the documentation?
The documentation should be organised so that you can find what you need based on the task you need to carry out
Use clear concise page names and headings so that someone scanning a list of pages or links can easily see the relevant page
Avoid creating empty stub pages - it makes it hard to know what's documented and what isn't, and someone else might document that concept in another section without realising a stub had been created
Last updated
