Skip to main content

📖 Quick Reference Guide - Eco Balance Documentation v2.0.0

Purpose: Fast navigation and understanding of the documentation structure Version: 2.0.0 (Bootstrap Model) Last Updated: 2025-11-08 For: All users - new and experienced

🎯 30-Second Overview​

What is this? Professional documentation for the Eco Balance ecological restoration project

How much content? 66 files, ~700 pages, 200+ cross-references

What's included?

  • 22 strategic planning documents (8 converted to Bootstrap Model)
  • 44 implementation task guides
  • Professional version control system
  • Templates and process documentation

Current Version: 2.0.0 (Bootstrap Model - Production Release)

🗺️ Documentation Map​

Root Directory (Core Content)​

📁 eco restoration project/
│
├── 📄 README.md                  ← Project entry point
├── 📄 00_Eco_Balance_Hub.md      ← START HERE - Main navigation
│
├── 📁 strategic/                 ← Strategic documentation (source of truth)
│   ├── 📄 01-70_*.md            ← 24 strategic documents
│   │   ├── 01-04: Core Strategy
│   │   ├── 10-13: Organization
│   │   ├── 20-22: Technical
│   │   ├── 30-32: Financial
│   │   ├── 40-44: Implementation
│   │   ├── 50-51: Risk & KPIs
│   │   ├── 60: Marketing
│   │   └── 70: Reference
│   │
│   └── 📁 restoration_playbook/  ← Restoration playbook template
│       ├── 📄 README.md         (1 file)
│       ├── 📁 site_selection/   (9 files)
│       ├── 📁 reforestation/    (7 files)
│       ├── 📁 biodiversity/      (7 files)
│       ├── 📁 soil_restoration/ (7 files)
│       ├── 📁 water_management/ (7 files)
│       └── 📁 community_engagement/ (7 files)
│
├── 📁 _process/documentation/    ← Meta/documentation files
│   ├── 📄 CHANGELOG.md          ← What changed between versions
│   ├── 📄 ROADMAP.md
│   ├── 📄 QUICK_REFERENCE_GUIDE.md
│   └── ... (other meta files)
│
├── 📁 _versions/                ← Version artifacts & reports
│   ├── README.md
│   └── 📁 v1.0.0/
│       ├── RELEASE_NOTES.md
│       └── 📁 reports/
│
├── 📁 _process/                 ← Development documentation
│   ├── README.md
│   ├── 📁 integration/
│   ├── 📁 migration/
│   ├── 📁 sessions/
│   └── 📁 refactoring/
│
├── 📁 _templates/               ← Templates for consistency
│   ├── strategic_document_template.md
│   ├── implementation_task_template.md
│   ├── release_notes_template.md
│   └── changelog_entry_template.md
│
└── 📁 archive/                  ← Historical documents
    └── Original comprehensive plans

🚀 Quick Start Paths​

Path 1: "I'm completely new"​

  1. Open 00_Eco_Balance_Hub.md (this is home base)
  2. Read strategic/01_Executive_Summary.md (5 minutes)
  3. Review _versions/v1.0.0/RELEASE_NOTES.md (10 minutes)
  4. Explore the Hub's navigation links

Time: 15-20 minutes to get oriented

Path 2: "I want to understand the project"​

  1. strategic/02_Project_Vision.md - Why we exist
  2. strategic/20_Restoration_Methodology.md - How we work
  3. strategic/04_Current_Status_Assessment.md - Where we are
  4. strategic/42_Adaptive_Timeline.md - What's next

Time: 45-60 minutes for comprehensive understanding

Path 3: "I need to DO something"​

  1. strategic/42_Adaptive_Timeline.md - Immediate actions
  2. strategic/restoration_playbook/README.md - All task guides
  3. Pick relevant category (e.g., site_selection/)
  4. Follow step-by-step instructions

Time: 10 minutes to find tasks, then execution time

Path 4: "I'm writing a grant/pitch"​

  1. strategic/01_Executive_Summary.md - Core pitch
  2. strategic/30_Business_Model.md - Sustainability
  3. strategic/20_Restoration_Methodology.md - Credibility
  4. strategic/51_Key_Performance_Indicators.md - Metrics

Time: 30 minutes to gather key points

Path 5: "I'm joining the team"​

  1. 00_Eco_Balance_Hub.md - Overview
  2. strategic/12_Team_Roles.md - Your potential role
  3. strategic/43_Operations_Action_Plan.md - How we operate
  4. strategic/04_Current_Status_Assessment.md - Current state

Time: 45 minutes to onboard

📍 Where to Find Things​

Strategic Planning​

Location: strategic/ directory, files 01-70

Quick Access:

  • Vision/Mission → strategic/02_Project_Vision.md
  • Current Status → strategic/04_Current_Status_Assessment.md
  • Legal Structure → strategic/10_Organizational_Structure.md
  • Technical Approach → strategic/20_Restoration_Methodology.md
  • Money → strategic/30_Business_Model.md & strategic/32_Funding_Strategy.md
  • Next Steps → strategic/42_Adaptive_Timeline.md
  • Risks → strategic/50_Risk_Assessment.md

Restoration Playbook (Template)​

Location: strategic/restoration_playbook/ directory

Quick Access:

  • site_selection/ - Finding and evaluating land (9 files)
  • reforestation/ - Planting and managing trees (7 files)
  • biodiversity/ - Protecting and restoring species (7 files)
  • soil_restoration/ - Improving soil health (7 files)
  • water_management/ - Sustainable water use (7 files)
  • community_engagement/ - Working with people (7 files)

Each category has:

  • 00_Overview.md - Start here for category introduction
  • 01-0X_Task.md - Detailed step-by-step guides

Note: This is a template/playbook - customize for your specific project

Version Information​

Location: Root and _versions/ directory

Quick Access:

  • Current version → VERSION file
  • What changed → CHANGELOG.md
  • v1.0.0 details → _versions/v1.0.0/RELEASE_NOTES.md
  • Reports → _versions/v1.0.0/reports/

Process Documentation​

Location: _process/ directory

What's here: How the documentation was created

  • Integration process → _process/integration/
  • Migration history → _process/migration/
  • Session summaries → _process/sessions/
  • Refactoring notes → _process/refactoring/

When to use: Onboarding AI assistants, understanding history, learning from past approaches

Templates​

Location: _templates/ directory

Available templates:

  • Strategic document template
  • Implementation task template
  • Release notes template
  • Changelog entry template

When to use: Creating new documents, maintaining consistency

Historical Documents​

Location: archive/ directory

What's here: Original comprehensive plans that were split into the current structure

When to use: Reference, comparison, backup

🔍 Finding Specific Information​

  1. Press Ctrl/Cmd + Shift + F
  2. Type your search term
  3. See results across all files
  4. Click to navigate

Use Graph View​

  1. Open any file
  2. Click graph icon in sidebar
  3. See visual connections
  4. Click nodes to navigate
  5. Use local graph for focused view
  • Click any [[link]] in documents
  • Navigate between related topics
  • Use back button to return
  • Follow "Related Documents" sections

Use Number System​

Files are numbered for easy sorting:

  • 00-09: Core strategy
  • 10-19: Organization
  • 20-29: Technical
  • 30-39: Financial
  • 40-49: Implementation
  • 50-59: Risk & performance
  • 60-69: Marketing
  • 70-79: Reference

🏷️ Understanding File Naming​

Strategic Documents​

Format: ##_Title_With_Underscores.md
Example: 20_Restoration_Methodology.md

Number ranges:

  • 00-09: Core strategy
  • 10-19: Organizational
  • 20-29: Technical
  • 30-39: Financial
  • 40-49: Implementation planning
  • 50-59: Risk & KPIs
  • 60-69: Marketing
  • 70-79: Reference

Implementation Tasks​

Format: ##_Task_Description.md (within category folders)
Example: 01_Assess_Soil_Health.md

Pattern:

  • 00_Overview.md - Category introduction
  • 01-0X_Task.md - Specific tasks in sequence

Meta Files​

Format: SCREAMING_CASE.md (all caps)
Example: CHANGELOG.md, VERSION

Purpose: Indicates important system files

Directories with Underscore​

Format: _directory_name/
Example: _versions/, _process/, _templates/

Purpose: Meta directories (not core content)

📦 Version Control Explained​

Semantic Versioning (SemVer)​

Format: MAJOR.MINOR.PATCH Current: 2.0.0

What changes what:

MAJOR (1.x.x) - Breaking Changes

  • Complete restructuring
  • Fundamental methodology changes
  • Incompatible with previous versions
  • Example: 2.0.0 - Complete overhaul

MINOR (x.1.x) - New Features

  • New implementation categories
  • Additional strategic documents
  • New tools/templates
  • Enhanced cross-referencing
  • Example: 1.1.0 - Add carbon sequestration category

PATCH (x.x.1) - Bug Fixes

  • Typo corrections
  • Link fixes
  • Content clarifications
  • Formatting improvements
  • Example: 1.0.1 - Fix broken links

Where Version Info Lives​

VERSION file: Plain text with current version number
CHANGELOG.md: Complete history of all changes
_versions/vX.X.X/: Artifacts for specific versions
RELEASE_NOTES.md: Detailed notes for each version

Using Version Information​

Check current version:

# Read VERSION file
cat VERSION
# Output: 1.0.0

See what changed:

  • Read CHANGELOG.md
  • Compare version entries
  • See specific changes by category

Get version details:

  • Open _versions/v1.0.0/RELEASE_NOTES.md
  • Read what's new, changed, fixed
  • See full documentation manifest

🎨 Using the Documentation​

Reading Strategic Documents​

Start with Overview:

  1. Open 00_Eco_Balance_Hub.md
  2. Navigate to topic of interest
  3. Follow wiki links to related topics

Deep Dive:

  1. Use numbered files (01-70)
  2. Read in sequence for comprehensive understanding
  3. Use cross-references to explore connections

Quick Reference:

  1. Use search for specific topics
  2. Check "Quick Navigation" in Hub
  3. Follow "Key Documents by Purpose" guide

Using Implementation Tasks​

Start with Category Overview:

  1. Navigate to implementation_tasks/
  2. Choose category (e.g., site_selection/)
  3. Open 00_Overview.md

Follow Step-by-Step:

  1. Read overview to understand process
  2. Work through 01, 02, 03... in sequence
  3. Use checklists to track completion
  4. Reference "Common Challenges" sections

Get Help:

  1. Check "Tips & Best Practices"
  2. Review "Resources Needed"
  3. See "Related Documents" for context

Contributing/Updating​

Making Changes:

  1. Use templates from _templates/
  2. Follow existing document patterns
  3. Maintain wiki-style links
  4. Update CHANGELOG.md

Version Updates:

  1. Edit VERSION file with new number
  2. Add entry to CHANGELOG.md
  3. Create new _versions/vX.X.X/ folder if needed
  4. Write RELEASE_NOTES.md for minor/major versions

Process Documentation:

  1. Document development process in _process/
  2. Create session summaries for continuity
  3. Keep process separate from core content

🔗 Key Relationships​

The Documentation Triangle​

Strategic Docs (00-70)
        ↓
Implementation Tasks
        ↓
    Execution

The Version Flow​

Edit Content → Update CHANGELOG → Bump VERSION → Create Artifacts

The Meta Structure​

Core Content (root) ← Users interact here
        ↓
Meta Dirs (_*/) ← Supporting infrastructure
        ↓
Version Control ← Historical record

💡 Pro Tips​

  • Bookmark the Hub (00_Eco_Balance_Hub.md) - Always return here
  • Use graph view - Visualize connections between topics
  • Follow numbering - Files sorted logically by number
  • Use search liberally - Fastest way to find specific content

Reading Efficiency​

  • Start with overviews - Get the big picture first
  • Follow wiki links - Explore related topics naturally
  • Use checklists - Track what you've read/completed
  • Check "Related Documents" - Found at bottom of each file

Working with Tasks​

  • Read category overview first - Understand overall process
  • Work sequentially - Tasks build on each other
  • Use templates - Save time on new documents
  • Document lessons learned - Add to relevant task files

Version Management​

  • Check VERSION before sharing - Know what version you're sending
  • Reference CHANGELOG - See what's changed since last review
  • Create minor version - When adding substantial new content
  • Update thoughtfully - Small changes = patch, new features = minor

⚡ Common Tasks​

"I want to share the project with a funder"​

  1. Send 01_Executive_Summary.md
  2. Include 30_Business_Model.md
  3. Add 51_Key_Performance_Indicators.md
  4. Reference VERSION for version number

"I need to find information about X"​

  1. Open 00_Eco_Balance_Hub.md
  2. Check Quick Navigation section
  3. Or use Obsidian search (Ctrl/Cmd + Shift + F)
  4. Follow wiki links to related topics

"I want to execute a restoration task"​

  1. Go to implementation_tasks/
  2. Choose relevant category
  3. Open 00_Overview.md
  4. Follow tasks 01, 02, 03... in sequence

"I'm creating new documentation"​

  1. Get template from _templates/
  2. Follow existing file naming convention
  3. Add wiki links to related docs
  4. Update CHANGELOG.md when done

"I need to know what changed"​

  1. Open CHANGELOG.md
  2. Compare versions
  3. Or read _versions/vX.X.X/RELEASE_NOTES.md

"I want historical context"​

  1. Check _process/ directory
  2. Read integration/migration docs
  3. See session summaries
  4. Review original docs in archive/

📊 Documentation Statistics​

Core Content:

  • Strategic documents: 22 files
  • Implementation tasks: 44 files
  • Total pages: ~700
  • Cross-references: 200+

Version Control:

  • Current version: 2.0.0
  • Release date: November 8, 2024 (v2.0.0 Bootstrap alignment)
  • Versioning: Semantic (MAJOR.MINOR.PATCH)

Structure:

  • Meta directories: 3 (_versions, _process, _templates)
  • Task categories: 6 (site, forest, bio, soil, water, community)
  • Strategic categories: 8 (strategy, org, tech, finance, etc.)

Quality:

  • Professional, grant-ready
  • Scientifically grounded
  • Fully cross-referenced
  • Template-based consistency

🎯 When to Use What​

Daily Operations​

  • Hub for navigation
  • Implementation tasks for execution
  • 42_Next_Steps_90_Days for priorities

Strategic Planning​

  • 01_Executive_Summary for overview
  • 02_Project_Vision for direction
  • 04_Current_Status for gaps

Grant Writing​

  • 01_Executive_Summary for pitch
  • 30_Business_Model for sustainability
  • 20_Restoration_Methodology for credibility
  • 51_KPIs for metrics

Team Onboarding​

  • 00_Hub for orientation
  • 12_Team_Roles for responsibilities
  • 43_Operations_Plan for workflows

Technical Work​

  • 20_Restoration_Methodology for approach
  • Implementation tasks for execution
  • 21_Technology_Integration for tools

Version Management​

  • VERSION for current version
  • CHANGELOG for history
  • _versions/ for reports

Process Understanding​

  • _process/ for development history
  • archive/ for original documents

🚨 Troubleshooting​

"I can't find a document"​

  • Check 00_Eco_Balance_Hub.md navigation
  • Use Obsidian search
  • Look at file numbering ranges
  • Check if it's in implementation_tasks/
  • Ensure you're using Obsidian (not plain text editor)
  • File must be in the vault
  • Check link syntax: [[filename|display text]]

"I don't know where to start"​

  • Open 00_Eco_Balance_Hub.md
  • Read QUICK_REFERENCE_GUIDE.md (this file!)
  • Check "Quick Start Paths" section above

"I need to understand the structure"​

  • Read "Documentation Map" section
  • Check "_process/refactoring/" for decisions
  • Review _versions/v1.0.0/RELEASE_NOTES.md

"Version numbers are confusing"​

  • Read "Version Control Explained" section
  • Check CHANGELOG.md for examples
  • See semantic versioning: MAJOR.MINOR.PATCH

📚 Additional Resources​

Core Files:

  • 00_Eco_Balance_Hub.md - Main navigation
  • VERSION - Current version number
  • CHANGELOG.md - Complete version history

System Documentation:

  • _versions/README.md - Version control guide
  • _process/README.md - Process documentation guide
  • _templates/ - All templates

Detailed Information:

  • _versions/v1.0.0/RELEASE_NOTES.md - This release
  • _versions/v1.0.0/reports/documentation_manifest.md - Complete file inventory

✅ Quick Reference Checklist​

Getting Started:

  • Read this Quick Reference Guide
  • Open 00_Eco_Balance_Hub.md
  • Check VERSION file
  • Review CHANGELOG.md
  • Explore graph view in Obsidian

For New Users:

  • Read 01_Executive_Summary.md
  • Review 02_Project_Vision.md
  • Check 04_Current_Status_Assessment.md
  • Explore implementation_tasks/README.md

For Contributors:

  • Read relevant templates in _templates/
  • Understand version control system
  • Know how to update CHANGELOG.md
  • Maintain wiki-style linking

For Execution:

  • Read 42_Next_Steps_90_Days.md
  • Choose relevant implementation category
  • Follow tasks sequentially
  • Use checklists to track progress

🎉 You're Ready!​

You now know:

  • ✅ How the documentation is organized
  • ✅ Where to find specific information
  • ✅ How to navigate efficiently
  • ✅ How version control works
  • ✅ How to use implementation tasks
  • ✅ How to contribute/update docs

Start exploring from the Hub: Eco Balance Hub

Document Version: 2.0.0 Last Updated: 2025-11-08 Status: Active

Questions? Check the Hub or search documentation!

← Back to Hub | View Changelog