This content originally appeared on DEV Community and was authored by Jessica Karpinski
Strong Systems Make Strong Businesses
You have two choices: Get bitter or get better. Choose wisely.
Step 1
Conduct an audit of any existing documentation or workflow graphics. There’s no need to reinvent the wheel!
Step 2
Create a template for the documentation. I recommend having a callout box field giving an estimated time it will take to read the document, followed by clear headers for each section, like Purpose, Procedure, and Troubleshooting.
Templates are required for any successful internal documentation project for various reasons including:
- They streamline the documentation development process.
- They standardize the documents for past, current, and future documents.
- The end user knows what to expect in the documentation when there are templates.
This content originally appeared on DEV Community and was authored by Jessica Karpinski