DeepSkill Platform Documentation
Welcome to the comprehensive documentation for the DeepSkill platform. This site documents user journeys, features, processes, developer guides, and technical systems for internal teams.
🗺️ User Journeys
Interactive visualizations of how different personas interact with the platform, connecting features, processes, and APIs.
Includes:
- Learner journeys (onboarding, sessions, learning modules)
- Coach journeys (coming soon)
- HR journeys (coming soon)
⚙️ Features
Documentation of core platform features including batch management, feedback systems, and role-based permissions.
Covers:
- Feature capabilities and use cases
- Configuration and setup
- User workflows
- Administrative controls
🔄 Processes
Automated and manual processes that orchestrate platform operations, from session scheduling to batch lifecycle management.
Includes:
- Process workflows and triggers
- Automation rules
- Integration points
- Monitoring and troubleshooting
View Processes Documentation →
👩💻 Developer
Guides for engineers who maintain the platform and its documentation — conventions, tooling, and how to publish technical content.
Includes:
- Weekly release workflow (
staging,production, andhotfix-*) - How internal processes are modeled (code → YAML → generated docs)
- Step-by-step workflow for adding process documentation
- Links to manifests, CI extraction, and journey integration
View Developer Documentation →
🔧 Backend
Technical documentation for the platform backend, including the complete API reference and internal systems documentation.
Contains:
- API Reference - Interactive Swagger documentation for all endpoints
- Cron Jobs - Scheduled automated tasks
- System Architecture - Technical implementation details
- Development Guidelines - Coding standards and best practices
💻 Frontend
Technical documentation for the frontend platform, including feature triggers and UI behaviors.
Contains:
- Feature trigger documentation
- Batch UI locking behavior
- Component documentation
📊 How-To Guides
Step-by-step guides for common tasks across different teams:
🔍 Quick Links
| Resource | Description |
|---|---|
| Learner Journey Hub | Interactive learner experience overview |
| API Reference | Interactive Swagger API docs |
| Processes Overview | All automated processes |
| Developer — Weekly release workflow | Feature branches, weekly production release, and hotfixes |
| Developer — Documenting processes | How to add YAML/code process docs |
| Features Overview | Platform features documentation |
Can't find what you're looking for? Use the search bar at the top of the page or reach out to the platform team on Slack (#platform-support).