For SMEs / Contributors
Subject Matter Experts (SMEs)
Certain users, such as leads and subject matter experts (SMEs), will help create and maintain pages in the knowledge base.
If that's you, the goal is simply to write down how the work is done.
Training & Development can help with editing, formatting, and organizing when needed, but the most important part is getting the knowledge out of our heads and into one place where everyone can use it.
Helpful things to include:
- What the task is
- When the task is used
- Step-by-step instructions
- Screenshots if helpful
- Links to related pages or systems
Things Will Change
During UAT and after go-live, procedures will change. This is expected and unavoidable.
Your job is to capture and document the steps while the information is fresh. It's better to document something that isn't perfect yet than to wait until everything is finished.