|
Describe the purpose of this topic in under 50 words here, using relevant keywords to optimize searching. The short description should contain an infinitive statement. |
Reference topics contain detailed reference data in formats that are presented in easily scannable structures such as tables, bullet lists, and code blocks. Reference topics should begin with an overview of the information being described and how it is formatted to assist users is quickly scanning for the information they need. To better aid usability for the end user, reference topics can be split into sections providing reference information about different facets of the topic in each. See below for examples and templates of reference information you can use to create a reference topic.
Elements used for reference topics should contain an introductory paragraph or sentence explaining what data is in the element.
Tables in reference topics contain reference materials in a scannable structure. The table below offers technical specifications for an internet router as an example.
| Specification | Description |
|---|---|
| Connectivity | Wi-Fi, Ethernet |
| Data Transfer Rate | 1900Mbps |
| Frequency Bands | 2.4GHz, 5 GHz |
| Total Ethernet Ports | 5 |
| Wireless Communication Standard | 802.11ac, 802.11b, 802.11a, 802.11n, 802.11g, |
Another structure for reference information is in bullet lists, which are useful for data that would not fit neatly in a table. Bullet lists should be preceded by an explanation sentence or paragraph.
Data Point
Data Point
Data Point
You can use an example element as needed if the information you're describing would be better understood by the user with one. Block quotes and code blocks are useful for this, depending on what kind of information is being presented to the user.
This is an example of a block quote example element used to clarify information being presented to the user in a section