Plan requirement
| Subscription | Any plan |
| Access | Agent |
What the article editor offers, and the three tools that do most of the work in a well-structured article.
The three that matter
- Headings. They create the article's structure, the table of contents, and how search understands it. Use real headings, never bold text pretending to be one.
- Lists. Numbered for steps that must happen in order, bulleted for things that do not. That distinction is information, so choose deliberately.
- Links. Between your own articles, above all. A knowledge base without internal links is a pile of documents.
The rest
- Bold and italic. Sparingly. A paragraph with five bold phrases has none.
- Images and video.
- Tables, for genuine comparisons.
- Callouts, for a warning or a tip that must not be missed.
- Accordions and tabs, for long reference content.
- Code blocks.
The source editor
For anything the toolbar cannot do, or for cleaning up what a paste from Word left behind. Pasted content carries a great deal of invisible formatting, and the source view is where you see it.
Headings in order
Do not skip levels for visual effect. Screen readers and search both use the hierarchy, and an article that jumps from a first-level heading to a third is harder to use than it looks.
Comments
0 comments
Article is closed for comments.