Hypothesis owner: @apaskulin
Hypothesis owner delegate: @VirginiaPoundstone
Start date: Jul 8, 2024
Target completion date: Nov 1, 2024
Hypothesis ID: [SDS2.1.5](https://meta.wikimedia.org/wiki/Wikimedia_Foundation_Annual_Plan/2024-2025/Product_%26_Technology_OKRs)
## Hypothesis
If we design a documentation system that guides the experience of users building instrumentation using the Metrics Platform, we will enable those users to independently create instrumentation without direct support from Data Products teams, except in edge cases.
## Scope
In scope:
- Creating an instrument
- Data contract and schema design docs
- Creating a place in the documentation system to add docs for to-be-developed features
- Client library documentation
- Template instrument docs standard
Out of scope:
- Documentation for concepts that are core to role-based expertise such as the basics of experiment design and data analysis
- Leading documentation for all features added during the fiscal year
- Maintainer docs for MP core and clients
- Migrating an existing instrument will be considered an edge case, and users will be directed to consult Data Platform
## Ownership
Following the project's completion, the Data Products team will own all documentation created by this project as part of their overall ownership of the Metrics Platform. After the project, Tech Docs will be available for reviews and help through our regular support channels.
## Project plan
- [x] **Phase 1**: Research and planning
- [x] Research existing documentation, and create project plan
- [x] {T370335}
- [ ] **Phase 2**: Pre-MPIC updates and organization
- {T371562}
- [x] {T372686}
- [x] {T372685}
- [x] {T372683}
- [x] {T372682}
- [ ] {T372681}
- [x] {T372679}
- [ ] **Phase 3**: Post-MPIC updates and organization
- [x] {T372690}
- [x] {T372680}
- [x] {T374742}
- [ ] {T372688}
- [ ] {T376434}
- [ ] {T376489}
- [ ] **Phase 4**: Cleanup
- [ ] {T370363}
- [ ] {T372689}
- [ ] {T372687}
- [ ] Create a glossary page
- [ ] Fix links to wiki pages in client code
- [ ] Recommended next steps
- [ ] Architecture overview for maintainers with system diagram
- [ ] Feature implementation status chart
## Outcomes
**Pre-MPIC docs**: In September 2024, the Growth team used the updated docs to create an instrument. Growth engineer Sergio Gimeno Saldaña stated that the docs were very helpful and that Growth was able to set up their instrument without asking Data Products questions about documented functionality. This means that the pre-MPIC docs were able to successfully accomplish their goal.
**Post-MPIC docs**: With the evolution of the Metrics Platform, the success of the pre-MPIC docs will quickly become obsolete. To fulfill the goal of the hypothesis in a way that supports the future of the platform, I will be implementing a new information architecture as part of the scope of this project. For more details see T372690.