Skip to content

🧭 Navigation Guide

Learn how to efficiently navigate the GetCimple documentation to find information quickly and understand how content is organized.

Documentation Structure Overview

The GetCimple documentation follows a logical hierarchy designed to match how different users approach the platform:

πŸ“ GetCimple Internal Documentation
β”œβ”€β”€ πŸ“‚ 01-getting-started/      # Orientation and onboarding (you are here)
β”œβ”€β”€ πŸ“‚ 02-strategy/            # Strategy and decision-making
β”œβ”€β”€ πŸ“‚ 03-core-principles/      # Values, principles, and governance framework
β”œβ”€β”€ πŸ“‚ 04-business/            # Business processes and stakeholder information
β”œβ”€β”€ πŸ“‚ 05-architecture/        # Technical architecture and implementation
β”œβ”€β”€ πŸ“‚ 06-features/           # Feature specifications and product roadmap
β”œβ”€β”€ πŸ“‚ 07-design/            # UI/UX design and user experience guidelines
└── πŸ“‚ 08-vision/            # Future vision and evolution

Understanding the Numbering System

The 01-08 prefix system provides clear organizational hierarchy:

  • 01: Entry point (getting started, orientation)
  • 02: Strategy (vision, goals, decision-making)
  • 03: Foundation (principles, governance, frameworks)
  • 04: Business layer (processes, stakeholders, workflows)
  • 05: Technical layer (architecture, implementation, technology)
  • 06: Product layer (features, capabilities, roadmap)
  • 07: Experience layer (design, user journeys, interfaces)
  • 08: Vision (future capabilities, evolution)

πŸ“– Reading for Understanding

Goal: Comprehensive understanding of a topic

Approach: Follow the logical sequence

  1. Start with the section index page for overview
  2. Read foundational documents first
  3. Progress to detailed specifications
  4. Check related sections for cross-cutting topics

Example: Understanding authentication

05-architecture/index.md β†’
authentication-with-kinde.md β†’
technical-implementation-guide.md β†’
04-business/processes/initial-setup/authentication-access-management.md

πŸ” Searching for Specific Information

Goal: Find answers to specific questions quickly

Approach: Use multiple search strategies

  1. Search function (top of page) with specific terms
  2. Index pages for section overviews
  3. Cross-references at bottom of documents
  4. Quick reference sections within documents

Search Tips:

  • Use specific terms rather than general concepts
  • Try both technical and business terminology
  • Check multiple related sections for complete answers

πŸš€ Task-Oriented Navigation

Goal: Complete a specific task or implementation

Approach: Follow implementation pathways

  1. Identify your user role and objective
  2. Use process flows and step-by-step guides
  3. Reference templates and examples
  4. Validate with technical specifications

Example: Implementing a new business process

Quick Start Guide β†’
04-business/processes/[relevant-process]/ β†’
Templates and examples β†’
05-architecture/[technical-requirements] β†’
Implementation

Document Types and Their Purpose

πŸ“‹ Index Pages (index.md)

Purpose: Section overviews and navigation hubs Content:

  • Section summary and scope
  • Key document listings with descriptions
  • Cross-references to related sections
  • Quick access to frequently needed information

When to use: Starting point for any new section

πŸ“Š Overview Documents

Purpose: High-level understanding of complex topics Examples: technical-architecture.md, process-flow-overview.md When to use: Need broad understanding before diving into specifics

πŸ“– Detailed Specifications

Purpose: Complete technical or business requirements Examples: Implementation guides, detailed process documentation When to use: Implementing or making decisions based on specifications

πŸ“ Templatest and Examples

Purpose: Standardized formats and real-world applications Location: Usually in /templates/ subdirectories When to use: Creating new content or following established patterns

πŸ“ˆ Diagrams and Visual Conten

Purpose: Visual explanation of complex relationships Location: /diagrams/ subdirectories within sections When to use: Understanding system relationships or process flows

Advanced Navigation Featurest

Look for these sections at the bottom of documents:

  • Related Sections: Links to relevant content in other sections
  • See Also: Additional resources and references
  • Next Steps: Logical progression for task completion

Content Hierarchies

Understanding when to go deeper or broader:

Go Deeper when you need:

  • Implementation details
  • Technical specifications
  • Step-by-step instructions
  • Complete requirements

Go Broader when you need:

  • Context and background
  • Related processes
  • Alternative approaches
  • Impact on other areas

Section-Specific Navigation Patterns

03-Core-Principles: Foundation-First

index.md β†’ core-principles.md β†’ [specific principle topics]

04-Business: Process-Focused

index.md β†’ stakeholders/ β†’ processes/[area]/ β†’ specific workflows

05-Architecture: Implementation-Oriented

index.md β†’ tech-stack-overview.md β†’ [specific technology] β†’ implementation guides

06-Features: Capability-Driven

index.md β†’ mvp/ or future/ β†’ [specific feature area] β†’ detailed specifications

Using Search Effectively

Search Strategies

  1. Exact Terms: Use quotes for specific phrases ("Essential Eight")
  2. Multiple Terms: Combine related concepts (authentication Kinde)
  3. Alternative Terms: Try different ways of expressing the same concep
  4. Section Filtering: Use section contexttt when you know the general area

Common Search Patterns

  • Process Questions: "How to [action]" or "[process] workflow"
  • Technical Questions: "[technology] implementation" or "[component] architecture"
  • Business Questions: "[stakeholder] experience" or "[concept] definition"
  • Reference Questions: "[term] meaning" or "[acronym] definition"

Mobile and Accessibility Featurest

Mobile Navigation

  • Hamburger Menu: Access full navigation on mobile devices
  • Search: Full search functionality available on all devices
  • Quick Links: Important links accessible without deep navigation

Accessibility Featurest

  • Keyboard Navigation: Full keyboard support for navigation
  • Screen Reader Support: Proper heading structure and alt tex
  • High Contrast: Dark mode support for better readability
  • Font Scaling: Responsive text sizing

Tips for Efficient Documentation Use

πŸ”– Bookmarking Strategy

Create bookmarks for:

  • Your role's main index page (e.g., 05-architecture/index.md for developers)
  • Frequently referenced documents (e.g., technology standards)
  • Templates you use regularly
  • Quick reference pages

πŸ“š Reading Patterns

  • Scan index pages first to understand scope
  • Use headings to jump to relevant sections
  • Follow cross-references for complete understanding
  • Check "Related Sections" for broader contextt

🎯 Focus Techniques

  • Single-section focus: Deep dive into one area at a time
  • Cross-cutting themes: Follow a concept across multiple sections
  • Task-oriented reading: Focus only on information needed for current task
  • Reference reading: Quick lookup of specific information

Common Navigation Challenges and Solutions

"I can't find what I'm looking for"

Solutions:

  1. Try the search function with different terms
  2. Check the most logical section's index page
  3. Look for cross-references in related documents
  4. Use the Key Concepts page for terminology

"I don't know where to start"

Solutions:

  1. Use the Quick Start Guide based on your role
  2. Start with section index pages for overviews
  3. Begin with core principles for foundational understanding

"Information seems scattered"

Solutions:

  1. Follow the cross-reference system
  2. Check for overview documents that synthesize information
  3. Use process flow documents for end-to-end understanding

"I need technical and business contexttt"

Solutions:

  1. Start with business section for requirements contextt
  2. Move to architecture section for implementation details
  3. Use feature section for capability understanding

Documentation Maintenance and Updates

Staying Curren

  • Recent Updates: Check section index pages for "What's New"
  • Last Modified: Each page shows last update date
  • Version Information: Track changes through git revision dates

Providing Feedback

  • Content Issues: Report through TaskMaster or established feedback channels
  • Navigation Problems: Document specific pain points
  • Missing Information: Suggest new content or improvements

Essential Starting Points

Most Frequently Referenced

Remember: Efficient navigation comes with practice. Use this guide as a reference while you become familiar with the documentation structure.