Reference information should be in an easily-scannable format, like a table or list. It’s similar to a dictionary or encyclopedia entry.
FormatReference topics should be in this format:
title: Title (a noun, like "Pipeline settings" or "Administrator options")
---
Introductory sentence.
| Setting | Description |
|---------|-------------|
| **Name** | Descriptive sentence about the setting. |Reference topic titles are usually nouns.
Avoid these topic titles:
Important notes. Instead, incorporate this information closer to where it belongs. This information might be a prerequisite for a task, or information about a concept.Limitations. Instead, move the content near other similar information. Content listed as limitations can often be considered prerequisite information about how a feature works. If you must, you can use the title Known issues.This topic was a compilation of a variety of information and was difficult to scan.
AfterThe information in the Overview topic is now organized in a table that’s easy to scan. It also has a more searchable title.
RetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4
