Search this site
Embedded Files
Skip to main content
Skip to navigation
Documentation Best Practices
Welcome!
About Amber
Amber's Dev Org Metadata
Case: Fields
Further Resources
Glossary
How will it be consumed?
Notes
The Process
Plan
Publish
Revise
Write
Tools
What format should I use?
When should I document?
Where should I put it?
Who is my consumer?
Why should I create documentation?
Documentation Best Practices
Plan
First and foremost...know your audience!
Who is my Consumer?
What do they know?
Are they technical? If so, how technical?
You might need to explain what a web browser is. Or, you might not.
What are their business expertise? Accounting? HR?
This can help with creating analogies that illustrate a point.
What do they need to know?
Knowledge
Are we documenting a Policy, Procedure, or Process?
Policy
What is the purpose?
What are we trying to prevent?
What are we trying to insure happens?
Procedure
What are the steps?
Is there a decision tree? If so, what are the criteria for each decision point?
Process
What are the inputs?
What changes, by whom, in what way?
What are the outputs?
Context
How does this new functionality fit into the broader business?
Does it replace or enhance a current function?
How will they be looking for the information?
What format should I use?
Google Sites
Report abuse
Page details
Page updated
Google Sites
Report abuse