Distribution List

Questions? Refer to the Knowledge Base Contributor Guidelines at https://wiki.calpoly.edu/x/vxYNEQ. 


In a sentence or two, describe what you are teaching the user and in what situations the information will be useful.

  1. Add the steps involved. If your article only has several steps, remove the below Expand macros. If your article is longer and includes multiple screenshots chunk the steps in the below Expand boxes, then include the full instructions with screenshots within the Expand macros. 


Add all steps involved:

  1. Enter more specific steps. Including screenshots? Place the screenshot directly below the step by pressing shift + enter/return to keep it in line with the step.


Add all steps involved:

  1. Enter more specific steps. Including screenshots? Place the screenshot directly below the step by pressing shift + enter/return to keep it in line with the step.


Add all steps involved:

  1. Enter more specific steps. Including screenshots? Place the screenshot directly below the step by pressing shift + enter/return to keep it in line with the step.


Add all steps involved:

  1. Enter more specific steps. Including screenshots? Place the screenshot directly below the step by pressing shift + enter/return to keep it in line with the step.


Add all steps involved:

  1. Enter more specific steps. Including screenshots? Place the screenshot directly below the step by pressing shift + enter/return to keep it in line with the step.


Info boxes contain info that is not necessary to follow steps but is important to consider in the overall process. Banner blindness can cause users to ignore boxes, so be careful of using too many boxes. Include anything the user might need. Does the user need to have a specific piece of software installed? Do they need any special permissions? Will they require a wrench to do this job?


Warnings alert users to crucial things to do or consider. They should be used even more sparingly than info boxes, and only when missing the information could cause really bad consequences for the user or might prevent them from being able to use it. This could be, for example, letting your audience know that a piece of software you're providing installation instructions for is not supported on very old versions of Windows.


Related Articles