@@ -71,6 +71,7 @@ correctly and safely.
7171- Step-by-step beginner introductions (→ Tutorials).
7272- Exhaustive parameter listings (→ Reference).
7373- Design rationale or architectural background (→ Concepts).
74+ - REST endpoints or configuration property keys when the procedure is UI-driven (→ Surface language).
7475
7576---
7677
@@ -105,6 +106,7 @@ product.
105106- Step-by-step instructions (→ Tutorials or Guides).
106107- Parameter or API field listings (→ Reference).
107108- Actionable procedures ("do X, then Y") (→ Guides).
109+ - Java field names, REST endpoint paths, or runtime config keys (→ Surface language).
108110
109111---
110112
@@ -186,3 +188,34 @@ Rules:
186188Use relative links between documentation pages. Prefer linking to a specific
187189section (` concepts/vulnerability-analysis.md#data-sources ` ) over linking to an
188190entire page when the relevant information is in a subsection.
191+
192+ ---
193+
194+ ## Surface language
195+
196+ Each Diataxis type has a default surface vocabulary. Match it to the audience
197+ that consults the page.
198+
199+ - ** Concepts** : UI labels and domain terms. Do not use Java field names
200+ (` isLatest ` , ` accessTeams ` , ` inactiveSince ` ), REST endpoint paths, or
201+ runtime configuration property keys. Refer to features the way they appear
202+ in the application. Permission codes and CycloneDX classifier names that
203+ surface verbatim in the product (BOMs, dropdowns, badges) are fine.
204+ - ** Guides** : describe procedures via the UI by default. The user's path is
205+ the form, the dropdown, the toggle. Inline REST endpoints, request bodies,
206+ or configuration property keys only when the page is itself a technical
207+ procedure where the API or config file is the user's entry point (for
208+ example, "Upload a BOM via REST API", "Configure with environment
209+ variables"). Otherwise, link to the relevant Reference subsection and keep
210+ prose UI-first.
211+ - ** Reference** : structured tables of UI-visible labels, dropdown values,
212+ classifier names, and other product-surface vocabulary belong here. The
213+ dedicated REST API and configuration-property references (the OpenAPI
214+ specs, the ` application.properties ` table) are the home for low-level
215+ identifiers. Other Reference subsections should also stay UI-first.
216+ - ** Tutorials** : same default as Guides. The student is using the UI unless
217+ the tutorial is explicitly an API tutorial.
218+
219+ When a feature has both a UI label and a technical identifier, prefer the UI
220+ label and link out to Reference for the identifier. The reverse breaks for
221+ users who never see the API or the config file.
0 commit comments