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 (work in progress)
- [x] **Phase 1**: Research and planning
- [x] Research existing documentation, and create project plan
- [x] {T370335}
- [ ] **Phase 2**: Updates and organization
- {T371562}
- [ ] Audit client library documentation, and plan improvements
- [ ] {T370363}
- [ ] {T372689}
- [ ] {T372686}
- [x] {T372685}
- [x] {T372683}
- [ ] {T372682}
- [ ] {T372681}
- [ ] {T372679}
- [ ] **Phase 3**: Testing and iteration
- [ ] Identify teams currently adopting and planning to adopt Metrics Platform during Q1 and Q2 to plan user testing
- [ ] **Phase 4**: Information architecture
- [ ] {T372690}
- [ ] {T372688}
- [ ] {T372687}
- [ ] {T372680}
- [ ] Finalize strategy for creation and maintenance
- [ ] **Phase 5**: End-to-end testing and iteration
- [ ] **Phase 6**: Wrap-up