Thursday, November 14, 2013

Formatting Knowledge for Reuse, or a K.I.S.S. Content Standard


Summary:

A descriptive and exemplary sample of knowledge formatted for reuse. 

Details:


Issue/Objective Description:

Describe the issue or objective in the end user/customers language
Use one symptom, requirement or idea per line
Complete thoughts are necessary, complete sentences are not
The more you have here the more complete your description of the issue or objective will be

Steps to reproduce issue or complete objective:

What steps to take to arrive at the failure point or end point

Environment:

Where the process occurs
What tools, objects, data, software are used in process
When the process occurs

Resolution/ Task Completion:

Steps to resolve the issue or complete the objective

Metadata:

Author
Date created
Date modified
State of knowledge (untested, tested, draft, archive, needs update)

No comments:

Post a Comment