Skip to main content

IT-Journey

Open-Source IT Education Platform

Status: Living Version: 2025-11-29 Auto-Generated:

0. WHY

Build IT-Journey — an open-source educational platform that democratizes IT education through gamified quests, practical tutorials, and AI-enhanced learning experiences, transforming complete beginners into skilled IT professionals.

KFI: 100% of learners who complete a quest path can demonstrate measurable skill improvement through hands-on projects in their portfolio.

1. MVP (Minimum Viable Promise)

As a learner / contributor / educator, I want:

Current Content Status

Source Count Status
Learning Quests 31 ✅ Published
Educational Posts 29 ✅ Published
Total Markdown Files 81 ✅ Indexed
Implemented Features 1 ✅ Tracked
Recent Commits 60 ✅ Analyzed
Detected Issues 4 ⚠️ Review needed

2. UX (User eXperience Flow)

graph TD
    A[New Learner] --> B[Visit IT-Journey Site]
    B --> C{Choose Path}
    C -->|Beginner| D[Zero to Hero Guide]
    C -->|Intermediate| E[Learning Quests]
    C -->|Advanced| F[Contribute & Create]
    D --> G[Complete Foundational Quests]
    E --> G
    G --> H[Build Portfolio Projects]
    H --> I[Skill Progression Tracked]
    I --> J[Community Recognition]
    F --> K[Create Quests/Tutorials]
    K --> J
    J --> L[🔄 Continue Learning Journey]
    L --> C

User Journeys

Beginner Path:

  1. Discover: Visit site → Browse quests by level
  2. Learn: Start with Level 0000 quests → Follow step-by-step tutorials
  3. Practice: Complete hands-on exercises → Build first projects
  4. Progress: Track skill development → Unlock advanced content

Contributor Path:

  1. Explore: Review existing content → Identify gaps or improvements
  2. Create: Write new quests/tutorials → Follow content guidelines
  3. Submit: Open PR → Get community feedback
  4. Iterate: Refine based on learner outcomes

3. API (Atomic Programmable Interface)

Route Content Purpose
/ Home Landing page with learning paths
/quests/ Quest Collection Browse gamified learning experiences
/posts/ Blog Posts Tutorials, case studies, guides
/docs/ Documentation Reference materials and guides
/notebooks/ Jupyter Notebooks Interactive code examples
/about/features/ Features Index Platform capabilities

CLI Tools

# Interactive terminal interface
./journey.sh

# Local development
bundle exec jekyll serve --config _config.yml,_config_dev.yml

# Docker development
docker compose up jekyll

# Quest validation
docker compose run quest-validator

# PRD synchronization
docker compose run prd-machine ./scripts/prd-machine/prd-machine sync

# Link health check
python3 scripts/link-checker.py --scope website

GitHub Actions Workflows

Workflow Trigger Purpose
build-validation.yml Push/PR Validate Jekyll build
link-checker.yml Schedule/Manual Check link health
prd-sync.yml Schedule/Push Update PRD.md
frontmatter-validation.yml Push Validate content metadata

4. NFR (Non-Functional Realities)

Category Requirement Metric Current
Accessibility WCAG 2.1 AA compliance Lighthouse score ≥90 🔄 In progress
Performance Fast page loads Time to Interactive <3s ✅ Static site
Availability Always accessible 99.9% uptime ✅ GitHub Pages
SEO Discoverable content Proper meta tags ✅ Jekyll SEO
Security Safe content delivery HTTPS everywhere ✅ GitHub Pages
Multi-Platform Cross-OS support macOS/Windows/Linux ✅ Documented
Mobile Responsive design All breakpoints ✅ CSS framework
Content Freshness Regular updates Activity within 30 days ✅ Active

5. EDGE (Exceptions, Dependencies, Gotchas)

Dependencies

Platform Requirements

Platform Requirements Notes
macOS Homebrew, Xcode CLI Primary development
Windows WSL2 recommended Docker Desktop
Linux Standard dev tools Native support
Cloud GitHub Codespaces Zero setup

Gotchas

Recent Issues Detected

6. OOS (Out Of Scope)

IT-Journey explicitly does NOT:

Focus Areas

The platform focuses on:

7. ROAD (Roadmap)

Milestone Objective Target Status
Foundation Jekyll site + GitHub Pages deployment 2024 Q1 ✅ Complete
Content Initial quest collection + tutorials 2024 Q2 ✅ Complete
Guardian 2.0 Advanced link monitoring + AI analysis 2025 Q1 ✅ Complete
PRD Machine Automated requirements documentation 2025 Q4 🔄 In Progress
Interactive Enhanced terminal interface + CLI tools 2025 Q4 🔄 In Progress
Community Contributor growth + content expansion 2026 Q1 📋 Planned
Certification Skill tracking + progress metrics 2026 Q2 📋 Planned
AI Tutor Personalized learning recommendations 2026 Q4 🔮 Vision

Upcoming Features

8. RISK (Top Risks)

Risk Impact Likelihood Mitigation
Content staleness 🟡 Medium Medium Automated freshness monitoring
Contributor burnout 🟡 Medium Medium Community growth + shared ownership
Technology obsolescence 🟡 Medium Low Regular stack reviews + updates
Broken links/content 🔴 High Medium Guardian 2.0 automated checking
SEO/discoverability issues 🟡 Medium Medium Jekyll SEO plugin + sitemap
Accessibility gaps 🔴 High Medium Regular audits + WCAG compliance

Risk Monitoring

The platform monitors health through:

9. DONE (Definition of Done)

Success Criteria

Validation Metrics

Metric Target Current Status
Quest Completion Rate >70% TBD 📋 Tracking planned
Content Freshness <30 days Active
Build Success Rate 100% 100%
Link Health >95% Monitored
Community Growth +10%/quarter Growing 🔄

When these criteria are met, IT-Journey fulfills its mission:

Democratizing IT education through open-source learning, gamified experiences, and community-driven content.

Keep learning. Keep building. Keep sharing. 🚀