Skip to content

docmeta:audience:1.0.0-proposal.1

The question it answers: who does this page serve, and who may see it? audiences works in any repo from the start. personas and journeys are the upgrade once a content strategy exists to point into. visibility is the access switch that downstream tooling can act on.

Field Type Notes
audiences string or list Who it is for, in your own words: administrators, sre. Plural because pages usually serve several groups. Not enumerated, because audience taxonomies belong to the org
personas string or list Ids into your content-strategy documents (persona-platform-admin). Adopt it once you keep personas; until then the ids would point at nothing
journeys string or list Ids of the user journeys (CUJs) this page belongs to. This is how a docs set shows it covers its own strategy
intent string, non-empty The reader’s job, in one line: deploy the operator on a running cluster. Retrieval matches questions against it
visibility enum draftrestrictedconfidentialinternalpublic
---
title: Install the operator on Kubernetes
description: Deploy the operator with Helm and verify the rollout.
audiences: [administrators]
personas: [persona-platform-admin]
journeys: [cuj-install]
intent: Deploy the operator on a running cluster
visibility: public
---
  • visibility is enumerated; audiences is not. Something downstream branches on visibility, and an unrecognized access level would fail open without anyone noticing. Audience taxonomies belong to the org, so audiences takes any label. The same reason produces both calls.
  • visibility folds a draft flag and an access level into one switch. Your generator’s own draft or unlisted keys remain its rendering controls, and this vocabulary does not claim them. A page can be visibility: public in metadata while the generator still hides it. Reconciling the two is a job for site tooling, not for a schema. visibility is also distinct from lifecycle (its own vocabulary). lifecycle: draft says the content is unfinished. visibility: draft says nobody outside the authors can see it. An unfinished page that is already visible inside the org is a legal and common combination.
  • There is no expertise field. Reader level belongs to the persona definitions a page points at. A page saying expertise: beginner next to personas: [persona-expert-admin] could contradict the persona’s own proficiency. This follows the family’s principle that a fact belongs at the level that owns it.
  • intent is free text. Most strings that nothing could enforce were cut. This one stays because machines consume it: retrieval and eval pipelines match reader questions against it.

Two questions. Are the five stages of the visibility ladder the right closed set for most orgs? And does keeping both audiences (labels) and personas (strategy ids) read as an upgrade path or as duplication?