This task represents the work with defining an initial process for proposing and making changes to the EditAttemptStep schema.
NOTE: we expect this process to evolve through use, over time.
Story
- As a data scientists who is needing to use the EditAttemptStep schema to help evaluate how successfully volunteers are able to use a particular editing interface, I need to easily and independently be able to confirm the meaning of each field within the schema, so that I can be confident the conclusions I am reaching by analyzing EditAttemptStep data are accurate.
- As data scientists who need to have discussions about evolving/changing the EditAttemptStep , we need to trust that every individual in the discussion has a shared understanding for what each field within the schema means, so that we can evolve our collective understandings with minimal miscommuniations/missteps.
Proposed Process
The process below has been effective in the two times it's been used to-date. Thus why we are proposing it be used more broadly and revised as needed.
Steps
Intended outcome(s)
This section should include a description of why the "Schema change(s)" are being proposed.
Schema change(s)
This section should include a description of what about the "schema(s)" in question the requesting team is proposing to change in order to achieve the "Intended outcome(s)".
| Proposed new event name | Field new event will "belong" to | Schema where event will be logged |
|---|---|---|
| app-android | platform | EditAttemptStep |
Implementation Process
This section should include the implementation steps below, adapted for the change(s) being proposed.
| Step | People/Team Responsible | Description | Status |
|---|---|---|---|
| 1. | Android | File ticket requesting instrumentation | ✅ Done in T307698 |
| 2. | Android | Populate the ===New instrumentation section with proposed changes, once defined | |
| 3. | @MNeisler + @DLynch | Review the ===New instrumentation Community Tech is proposing to introduce | |
| 4. | Android | Implement the instrumentation changes defined in ===New instrumentation | |
| 5. | Editing Team | Code review the instrumentation changes Community Tech will have implemented | |
| 6. | Android | Verify newly instrumented events are being emitted as expected by clients | |
| 7. | Product Analytics | Verify newly instrumented events are being logged in database as expected, once the new instrumentation has landed in production. | |
| 8. | Android | Update schema documentation with the events spec'd in this task once they have been verified to be implemented as expected. Read: clients are emitting events as expected and said events are being logged in the database as expected as well. | |
Process Consultation
| Team | Process approver(s) | Status (e.g. supportive of proposed process) |
|---|---|---|
| Community Tech | ||
| Android | ||
| Structured Data | ||
References