Internal · SpaceMusic · Documentation
Documentation — Status
The six kinds of documentation, what each one covers, and roughly how far along it is.
| # | Documentation | What it covers | Progress (estimate) | Status | Where it stands |
|---|---|---|---|---|---|
| 01 | Patches | Everything inside vvvv: the patches and how they work. | % |
Early | We are building it with the VL Grapher tool. |
| 02 | Architecture | How everything works together: the Factory, the Host, the UI, the Core and more. | % |
In progress | Shown on different levels, from the big picture down to each part. |
| 03 | Server | The whole web backend of SpaceMusic and how it is built. | % |
Almost done | Basically complete. |
| 04 | Development | Everything around developing for SpaceMusic. | % |
Far along | A lot of it is done. |
| 05 | Factory | Everything around the Factory. | % |
Done | Already done. |
| 06 | User manual | What a person who uses SpaceMusic reads to work with the software. | % |
Early | Needs new screenshotsGaps in written docs A lot is not written down yet. |
Video documentation
Probably out of dateThere is a lot of video for some topics.
How to read this sheet
Done100 %.
Almost doneOpen. 90 % or more.
Far alongOpen. 60 to 89 %.
In progress · EarlyOpen. 30 to 59 % · under 30 %.
Glossary
- vvvv
- The visual programming tool that SpaceMusic is built in. A patch is a program drawn in vvvv.
- VL Grapher
- Our tool that reads the vvvv patch files and draws diagrams of them.
- Host
- The desktop app a user opens. It starts the Core and shows the UI.
- Core
- The vvvv engine that renders the scene.
- UI
- The controls for the scene: the Pro UI in the Host and on the web.
- Factory
- Runs automations on the studio machines and keeps every result for review.
- Server
- The web backend: the services behind our websites, such as the api, the Factory and the docs.