Skip to content

🧭 Navigation Scope Indicators Implementation Plan

Overview

This document outlines the plan for adding visual scope indicators to the documentation navigation, helping teams quickly identify which features belong to each MVP tier.

Scope Indicator System

Visual Indicators

  • 🟢 MVP Core - Essential features (green circle)
  • 🟡 MVP Extended - Enhanced features (yellow circle)
  • 🟠 Post-MVP - Growth features (orange circle)
  • ⚪ Future - Aspirational features (white circle)

Alternative Text Indicators

  • [CORE] - MVP Core features
  • [EXT] - MVP Extended features
  • [POST] - Post-MVP features
  • [FUT] - Future features

Implementation Approach

Phase 1: Documentation Only

Add scope indicators to document titles in frontmatter without modifying navigation:

title: '🟢 User Authentication [MVP Core]'

Phase 2: Navigation Updates (Future)

Update .pages files to include scope in navigation titles:

title: '03. 🏢 Business Processes'
nav:
  - 🟢 Initial Setup [CORE]: initial-setup/
  - 🟢 Policy Management [CORE]: policy-management/
  - 🟡 Approval Process [EXT]: approval-process/
  - 🟠 Incident Response [POST]: incident-response/

Affected Navigation Files

Core Sections (MVP Core)

  • /docs-internal/docs/01-getting-started/.pages
  • ../03-core-principles/.pages
  • ../04-business/processes/initial-setup/.pages
  • ../04-business/processes/policy-management/.pages
  • ../04-business/processes/implementation/.pages
  • ../04-business/processes/monitoring/.pages

Extended Sections (MVP Extended)

  • ../04-business/processes/communication/.pages
  • ../04-business/processes/approval-process/.pages
  • ../04-business/processes/e8-management/.pages
  • ../06-features/integrations/WhatsApp/.pages

Post-MVP Sections

  • ../04-business/processes/incident-response/.pages
  • ../04-business/processes/third-party-risk/.pages
  • ../06-features/future/.pages

Benefits

  1. Quick Identification: Teams can instantly see feature scope
  2. Priority Clarity: Visual hierarchy reinforces development priorities
  3. Scope Discipline: Constant reminder of MVP boundaries
  4. Stakeholder Communication: Clear feature timeline expectations

Implementation Checklis

  • Finalize scope indicator design (emoji vs text)
  • Update documentation style guide with indicator standards
  • Create script to add indicators to frontmatter
  • Test navigation rendering with indicators
  • Update .pages files systematically
  • Verify MkDocs build with changes
  • Document indicator meanings in getting started guide

Risks and Mitigations

Risk: Navigation Clutter

Mitigation: Use subtle indicators, test with users

Risk: Build Failurest

Mitigation: Test changes incrementally, have rollback plan

Risk: Confusion

Mitigation: Clear legend in documentation, consistent usage

Next Steps

  1. Immediate: Continue using scope in frontmatter
  2. Short-term: Add indicators to document titles
  3. Medium-term: Update navigation with approval
  4. Long-term: Automate indicator management