Skip to main content

Document metadata

Status
Review candidate
Approval
Pending
Version
1.0
Classification
PUBLIC
Owner
Lightning IT Documentation Maintainers
Approver
Lightning IT Product Owners
Audience
documentation architects, product owners, content designers, accessibility reviewers
Last reviewed
Next review
(Annual)

Information architecture and navigation model

This planning record defines the target public information architecture. It does not rename existing products, create routes, or authorize implementation. Product and foundation labels remain governed by the integrated #38 decision.

Audience and findability model

Readers enter by intent rather than organization chart:

AudiencePrimary questionPrimary entryRequired onward paths
EvaluatorWhat outcome and boundary does this have?Home, portfolio, product overviewtrust, limitations, support
PractitionerHow do I use or operate it safely?product task and operations pagesprerequisites, security, troubleshooting
ArchitectHow does it fit and what are the limits?architecture and product architectureintegrations, trust, evidence, decisions
Security reviewerWhat is publicly supported and governed?Trust Centersecurity, evidence, compliance mappings
Compliance reviewerWhich evidence supports which mapping?Compliance and Evidence centersauthority, limitations, source record
ContributorHow do I change documentation?Contributing and governancetemplates, lifecycle, validation, approval
Support-seeking userHow do I recover or escalate?Supportproduct troubleshooting, safe contacts

Labels use reader language, not repository paths. Every landing page states scope, intended audience, canonical owner, and the next useful destinations.

Target top-level site map

Home
├── Get started
├── Products
│ └── <approved product> (repeatable)
│ ├── Overview
│ ├── Concepts
│ ├── Architecture
│ ├── Use / procedures
│ ├── Operations
│ ├── Security
│ ├── Troubleshooting
│ ├── Lifecycle / releases
│ └── Reference
├── Foundations
│ └── <approved shared foundation> (repeatable)
├── Trust Center
│ ├── Security
│ ├── Privacy and publication boundary
│ ├── Reliability and recovery
│ └── Responsible disclosure and support
├── Evidence Center
│ ├── Evidence catalog
│ ├── Validation and provenance
│ ├── Approval and publication records
│ └── Retention and limitations
├── Compliance
│ ├── Mapping method
│ └── <framework mapping> (repeatable)
├── Architecture
├── Documentation governance
├── Releases
├── Support
├── Reference
└── Contributing

This covers every #15 area while keeping product content separate from shared standards. Restricted references are never nodes in the public tree. A public page may cite only an approved public extract or safe authority reference.

Canonical location and ownership

AreaCanonical routeCanonical sourceOwner
Home/site shellDocumentation Maintainers
Getting started/getting-started/docs/getting-started.*Documentation Maintainers
Product/products/<product>/docs/products/<product>/Named Product Owner
Foundation/foundations/<foundation>/docs/foundations/<foundation>/Named Foundation Owner
Trust Center/trust/docs/trust/Security and Trust Owner
Evidence Center/evidence/docs/evidence/ plus governed evidence indexEvidence Owner
Compliance/compliance/docs/compliance/Compliance Owner
Architecture/architecture/docs/architecture/Documentation Architects
Documentation governance/documentation-governance/docs/documentation-governance/Documentation Maintainers
Releases/releases/docs/releases/Release Owner
Support/support/docs/support/Support Owner
Reference/reference/docs/reference/Documentation Maintainers
Contributing/contributing/docs/contributing/Repository Maintainers

Current product routes remain canonical during transition. Moving them beneath /products/ is a target option, not an implicit redirect decision. #38 must approve the taxonomy and route mapping before implementation.

Each planned page has exactly one canonical source and owner. A sidebar entry, card, search result, tag, translation, version, or framework view points to that record and does not become another canonical owner.

Extensible product subtree

A product is added without changing the top-level model:

  1. approve its public name, stable identifier, role, and Product Owner;
  2. create one landing page using the product documentation standard;
  3. add only applicable child types from the standard product subtree;
  4. link shared trust, compliance, evidence, and governance pages instead of copying them;
  5. validate routes, navigation, search, accessibility, and redirects; and
  6. bind approval to the resulting exact document digest.

Foundations follow the same process under a distinct namespace. Promotion from foundation to product is a consequential taxonomy and compatibility decision.

Documentation taxonomy

Taxonomy is metadata for filtering, validation, and relationships; it does not create routes automatically.

FacetControlled values or rule
Content typeoverview, concept, architecture, procedure, operations, security, troubleshooting, reference, evidence, policy, mapping, release
Audienceevaluator, practitioner, architect, security, compliance, contributor, support
Productapproved stable product identifier; omitted for portfolio-wide content
Componentapproved product-local or shared component identifier
Lifecycleproposed, review-candidate, maintained, deprecated, retired
Approvalpending, approved, rejected, expired
Evidencezero or more stable evidence identifiers with relation: supports, verifies, supersedes, or limits
LocaleBCP 47 language tag with one canonical source-language relationship
Versionunversioned-current or an explicit supported documentation version
Classificationpublished pages are PUBLIC; PUBLIC_AFTER_SANITIZATION source requires the independent review defined by AGENTS.md

Facet values require a controlled registry, owner, documented addition rule, and validation. Free-form tags must not silently define products, controls, or approval state.

  • Product pages link outward to canonical shared security, trust, compliance, evidence, support, and governance records.
  • Shared pages link inward only when a product-specific relationship is verified and useful; they do not imply blanket product coverage.
  • Procedures link prerequisites before actions and verification, recovery, and support after actions.
  • Compliance mappings link both the public authority and qualifying evidence; evidence links back to the exact claim or mapping it supports.
  • Deprecated pages link to their successor and retirement record.
  • Link text describes the destination without relying on surrounding context.

URL, slug, redirect, and duplicate-content rules

  1. Canonical routes are lower-case, human-readable, slash-terminated, stable, and independent of sidebar order.
  2. A page declares a stable document id and explicit slug; filename changes do not silently change a public route.
  3. Product, locale, and version identifiers use controlled registries.
  4. A moved or renamed published route receives a permanent one-hop redirect to the canonical route. Redirect chains, loops, wildcard ambiguity, and cross-classification redirects are prohibited.
  5. Redirect records include old route, canonical route, reason, owner, introduction date, review trigger, and removal decision.
  6. One content body owns each canonical claim. Repeated summaries are short, linked, and tested for conflicting normative language.
  7. Query parameters, fragments, translated views, printable views, and search facets do not create additional canonical ownership.
  8. Breadcrumbs reflect the information hierarchy, not browser history: Home > top-level landing > optional product/foundation > page.
  9. Breadcrumb labels match navigation labels, remain keyboard-operable, expose an accessible navigation name, and mark the current page.

Global navigation exposes Home, Products, Trust, Evidence, Compliance, Support, and search. The documentation sidebar exposes the complete hierarchy for the current top-level area. In-page navigation exposes logical headings only. Previous/next links follow curated task sequence, not incidental filename order.

Accessibility and responsive validation

Acceptance requires:

  • desktop navigation at supported viewport widths without obscured content;
  • a mobile menu that opens, closes, traps no focus, restores focus to its trigger, and remains usable at 400% zoom;
  • complete keyboard operation with logical order, visible focus, skip link, and no keyboard trap;
  • semantic nav landmarks with unique accessible names, correct expanded state, current-page state, headings, lists, and link names;
  • no meaning conveyed only by color, position, hover, icon, or animation;
  • reduced-motion support and adequate pointer target size;
  • breadcrumbs, sidebar, global navigation, search, and previous/next links available to assistive technology;
  • route, orphan-page, duplicate-ID, duplicate-canonical, redirect, and broken cross-link validation; and
  • representative automated and manual checks for each top-level area, product subtree, locale, and supported version.

Current, transition, and target decisions

Current state uses explicit product categories plus Architecture, Security, Compliance, Documentation governance, Releases, Support, Reference, and Contributing. Trust and Evidence centers and a distinct Foundations namespace are absent.

During transition, existing routes and labels remain stable while #29–#33 define the missing centers, taxonomy relationships, localization, and search. No placeholder is exposed as if complete.

The target adopts this site map after #38 approval. Implementation must include a route inventory, redirect table, orphan report, responsive and assistive- technology results, and exact-digest approval evidence.

Open decisions

DecisionOwnerResolution gate
Approved product and foundation identifiersProduct Owner#38
Preserve or migrate current product rootsProduct Owner#38 ADR
Trust and Evidence Center page inventoryTrust/Evidence Owners#29/#30
Locale prefix and source-language behaviorDocumentation Maintainers#33
Documentation version position in URLsProduct and Release Owners#33
Redirect retention and removal thresholdDocumentation Maintainersimplementation ADR

Until those decisions are accepted, existing public routes and the current portfolio wording remain authoritative.