Project 1.6: TaskFlow Documentation
Create comprehensive documentation for TaskFlow following platform engineering best practices.
Lab Overview
🛠Lab from the Platform Engineering Bootcamp. Used in Week 1. Bootcamp landing page: https://academy.tekanaid.com/bootcamps/platform-engineering-bootcamp Parent course(s):
- Week 1: DevOps & Platform Engineering Overview (slug: devops-platform-engineering-overview)
🟡 Beta bootcamp lab. Hands-on instructions, check scripts, and solve scripts are in place. Lab is part of the running TaskFlow project that grows across all 21 weeks of the bootcamp.
Good documentation is the foundation of successful platform engineering. In this project, you'll create the essential documentation that makes TaskFlow accessible to developers, contributors, and users.
This isn't busy work - professional documentation is what separates hobby projects from production-ready platforms. Your TaskFlow documentation will be the first thing employers see when they visit your GitHub portfolio.
By the end of this project, you'll have:
- A comprehensive README.md with setup instructions
- A CONTRIBUTING.md guide for future contributors
- Architecture documentation explaining system design
- API documentation for developers
What You'll Learn
Write a professional README that communicates project purpose and getting-started instructions
Create a CONTRIBUTING guide that establishes code standards and pull request processes
Produce architecture documentation that explains technical design decisions
Write API documentation that serves as a contract for frontend-backend integration
Prerequisites
Completed Project 1.5 (TaskFlow Vision)
Understanding of platform engineering concepts
Technologies Covered
Choose your plan
Simple, Transparent Pricing
Unlock full access to TeKanAid courses, labs, and bootcamps
Just exploring? Start free below. Want the full experience? Try Premium free for 7 days (card required, $0 today).
Pro
All courses, with lab scripts to run on your own machine
Renews automatically. Cancel anytime.
Final price verified at checkout.
- Full access to all courses
- Lab scripts to download and run on your own machine (hosted labs not included)
- Progress tracking
- Certificate of completion
- Community access
- Bootcamp participation
- New content access
Premium
Full access, including unlimited hosted labs
Renews automatically. Cancel anytime.
Final price verified at checkout.
- Everything in Pro
- Unlimited hands-on labs, fully hosted on TeKanAid Academy (nothing to set up)
- Lab AI Assistant
- Accelerator bootcamps with live office hours
- Priority support
Prefer a single course?
Purchase individual courses for a one-time fee of $79. Full access to course content, quizzes, certificates, and community features, lab access is not included.
Browse CoursesJust exploring? Start free, no account needed
Three free ways to start. All bridge into the paid Premium catalog when you're ready.
Not ready to commit? The crash course is email-only. No academy account required.
Ready to Get Started?
Start this hands-on lab and build real-world Platform Engineering skills
Get Access Now