If you won the lottery tonight, could a coworker step into your shoes and carry on business as usual? Documenting your processes and saving them in a place your team members can easily access allows teammates to cover for one another (and you!) and expand your team without losing a beat. Come for insights on what to document, how to upkeep your files, and real-life examples.
6. Why is Documentation Important?
Benefits
● Consistency & quality control
● Efficiency
● Risk mitigation
Risks
● Loss of time and money
● Appear uninformed
● Incomplete processes
6
9. 9
Types of Documentation
● Executive Summary
● Strategic Brief
● Solution Design
● System Configuration
● Job Aid
● Regulations
10. Components of Documentation
● Business Objectives
● Solution Design Plan
● High level flows / relationships
● Dependencies
● Impact
● Configuration basics:
what / how / when
10
11. What Should I Document?
11
Examples
Leadership: executive summary that includes risk assessment, strategic brief
with objectives, product road map, document decisions/approvals
Consultants/Agencies: new Marketing Cloud platform implementation plan,
meeting notes, software architecture diagram
End User: job aid for how to add users to a system, a process for adding new
campaigns to Salesforce, or data flow from LinkedIn to Zapier to Pardot
13. 13
Naming Conventions
● Be consistent
● Short but descriptive
● Avoid special characters
● Include the date
● Include version number (if needed)
● Consider compliance requirements
○ Section 508
14. 14
Storing Documentation
Examples
● Folder on your server
● Sharepoint
● Salesforce Libraries
● Dropbox
● OneNote
● Google Drive
● MasterControl
● Asana/Monday/Trello
● Jira/Confluence
Store in a central location
Create a repository
Consider:
● Identify stakeholders and make
sure they have access
● Who shouldn’t have access
● Document format
22. Getting Started
Health Check
● Identify any gaps in current processes
● Is there knowledge you may only know?
● New initiatives coming
● Update existing documentation
22
23. Plan Ahead
● Leadership/stakeholder support
● Implement a timeline
● Establish roles and responsibilities
○ RACI
● Create templates to streamline
● Prioritize
23
24. What Do You Only Know?
Take a minute to write down something you do that
no one else on your team may know.
24
25. Worksheet
Current Processes
● List all
● Get input
Identified Needs
● Focus on one
department
25
Edit to fit your needs!
Download worksheet