Skip to main content

Types of page

Every page in these guides answers one kind of question. The kind is recorded as knowledge_class. Code examples are the extra kind used in the admin guides.

Meaning​

A meaning page explains an idea, and why the work is shaped around it. It does not tell you which control to click.

Read one when a screen will not make sense until you know what the thing is for.

Practice​

A practice page is one job, with the steps that finish it. The title is the job.

Read one when you already know what you are trying to complete.

Judgement​

A judgement page helps you read a situation and choose a next move. It is for the moment when the same screen could lead two careful people to different decisions.

Illustration​

An illustration shows the work as a whole, as a case study at Burnham Thorpe Tech. It opens with a reminder of that case study. It owns the situation and the choices. Definitions and steps stay on their own pages, and the illustration links to them.

Catalogue​

A catalogue page is a closed list you look up: the kinds of object, the states an object can be in, or the names for a link. Each entry is a name, one sentence of meaning, and the rule for when to use it.

Other pages use the catalogue name and link to the entry. They do not invent a second word for the same thing.

Code example​

A code example is one working fragment an administrator can adapt: a script, a query, or a configuration snippet. The idea and the steps stay on their own pages. Code examples live in the admin guides.