Reference articles give general information about a subject, application, or a policy. Can include a breakdown of detailed information about subjection, application, or policy.
Critical Concepts
- Reference articles contain 2 sections:
- Overview - Concise description of the topic / policy - What is this? What is it used for? Who is the intended audience (faculty, staff, students)?
- Fact - For short topics that only require a few sentences or paragraphs, you only need to enter the description - no need to add additional heads or titles.
Steps to Take
- If your topic needs detailed breakdown, select Reference template to setup article structure.
-
- If you do not have access to the templates, please submit a ticket to the ITS Service Desk or email us at servicedesk@ucsd.edu.
- Make sure to set the appropriate Knowledge Type as well.
- This will divide the page into multiple sections. Replace the generic headings (Heading 1, 2, etc.) with the main topics.
- Feel free to divide article into more or less main topics as necessary, following same format.
- If additional breakdown needed, use h3 subheadings for minor topic headings. If not necessary, delete subheadings.
- Under Overview, erase placeholder text and enter:
- Brief description of the topic or policy (preferably a sentence or two) - What is this? What is it used for? Who uses this (intended audience, if applicable)?
Reference Articles:
Reference Source Code
<h2>Overview</h2><hr /><p>Enter overview text here.</p><p> </p><h2>Heading 1</h2><hr /><h3>h3 for Subheadings as needed</h3><p>Enter text here </p><p> </p><h2>Heading 2</h2><hr /><h3>h3 for Subheadings as needed</h3><p>Enter text here</p><p> </p><div class="contact"><p>If you still have questions or need additional assistance, please submit a ticket.</p></div> |
If you need further assistance in creating or editing a Knowledge Base article, please submit a ticket or email servicedesk@ucsd.edu