Project Aria Docs Case Study
Problem
Aria Data Tools was created in a very small window of time for a specific release. After the success of Aria Data Tools, we needed to create a much larger website that catered to multiple audiences. Research Partner only documentation was going to be made open source. The site needed to be able to support a lot more tooling (C++, Python, apps and a SDK), use cases and data releases.
Actions
Working with a much larger team of SMEs we created Project Aria Docs (originally called Project Aria Tools) within a very tight timeline. This site was then added to and evolved over time. I created templates to drive clarity and consistency in associated content (such as the HOT3D README).
Outcomes
Enormously positive feedback from our users about the quality of our documentation, especially when compared to other documentation in the field. It is really nice to hear PhD students loudly exclaim "Your documentation is amazing, it saved me!" etc.
Engineers and researchers have thanked me for raising the standards around documentation and that they'll take these principles forward into future projects.
Sample Pages
- Introduction to Project Aria Docs
- Project Aria FAQ
- Recording Profiles
- Timestamp Definitions
- Aria Glasses Quickstart Guide
- Time Synchronized Recordings with Multiple Aria Glasses
- HOT3D README Commit
- Commit showing how content has been improved and made consistent with the larger Project Aria product family
- Machine Perception Services (MPS) - a cloud-based service