Documentation is part of the product
Eduternative documentation is intended to answer more than “which button do I press?” It should explain how to use a project, why it behaves that way, how it was built, how it was tested, and what another learner or developer can take from it.
Documentation layers
- User documentation for installation, settings, workflows, and troubleshooting.
- Teaching documentation for concepts, decisions, examples, and guided exercises.
- Developer documentation for architecture, hooks, data, security, accessibility, and extension points.
- Project documentation for changelogs, testing, roadmaps, known limitations, and release preparation.
Use the Plugins and Themes pages to find project-specific material, or move into the Tutorials library for guided practice.
Frequently Asked Questions
Why is documentation part of the product?
Documentation is part of the product because it should explain more than which control to use. It should also cover why a project behaves as it does, how it was built and tested, and what another learner or developer can take from it.
What kinds of documentation are available?
Available documentation includes user documentation for installation, settings, workflows, and troubleshooting, teaching documentation for concepts, decisions, examples, and guided exercises, developer documentation for architecture, hooks, data, security, accessibility, and extension points, and project documentation for changelogs, testing, roadmaps, known limitations, and release preparation.