Schema for these docs
The schema every page's front matter is checked against, and the JSON-LD each page carries.
The check
Every page here is a typed topic. Its front matter is checked against /schema/topic-types.json when the site is built, and a page that fails the check does not ship. The schema is generated from the content model behind these docs: DITA 2.0 topic types, each mapped to a schema.org type.
Page types
| Page type | schema.org type | Status |
|---|---|---|
| topic | TechArticle | in use |
| concept | TechArticle | in use |
| task | HowTo + TechArticle | in use |
| reference | TechArticle | in use |
| troubleshooting | TechArticle | in use |
| glossentry | DefinedTerm | in use |
| map | WebSite | in use |
| topicref | ListItem | in use |
| subjectScheme | DefinedTermSet | in use |
| release-note | TechArticle | proposal |
| decision-record | TechArticle | proposal |
What every page carries
- A stable id equal to its address, and a canonical address.
- A short description, an audience and the date it was last updated.
- One JSON-LD block with the site, the page, its breadcrumb and the main topic, typed as in the table above.
- A markdown twin at the same address ending in
.md, and an entry in /llms.txt.
Facet values
The allowed values for audience and the other facets are listed in the glossary.