"How To" Article


Overview


How To's are articles with step-by-step instructions for completing a tasks and procedures.  

Critical Concepts


Steps to Take


  1. Select How To template to setup article structure.
    • If you have a process that has many primary substeps , use How To (Steps w/substeps).  See example linked below if unsure.
    • Make sure to select Knowledge Type: How To
  2. This will divide the page into 3 sections with the following headings (using Heading 2 (h2)):
    • Overview
    • Critical Concepts
    • Steps to Take
  3. In Overview section enter a concise description of the process, considering the following questions:
    • What is this?  
    • What is it used for?
    • Who is the primary audience of this article?
  4. In Critical Concepts section, enter bullet points of Key Concepts:
    • Include the following as needed:
      • Things to keep in mind
      • Goals
      • Definitions
      • Prerequisites to the process
      • Common misunderstandings
    • Ask yourself:
      • Is this a step that needs to be taken OR is this something to keep in mind. If it is something that needs to be "done" to accomplish the goal, it is most likely a Step to Follow.
  5. In Steps to Follow section, rename subheadings as needed (or erase if no further breakdown necessary)
  6. Enter detailed walkthrough of the process, this can include:
    • Step-by-Step procedures, instructions
    • Work flow charts, process maps

How To articles:

How To (Steps w/substeps) articles:

If you need further assistance with creating or editing Knowledge Base articles, please submit a ticket or email us at servicedesk@ucsd.edu