Background/Goal
AQS 2.0 has progressed over the last year, as we approach the finish line, we need to clearly define the remaining scope to ensure a smooth deployment and effective launch.
User stories
- As an API Platform Team member, I need to align on remaining scope of work, so I am clear about my role in the process.
- As an end user of AQS 2.0, I need to be able to follow AQS 2.0 progress and definition, so I can help ensure it will meet my needs and can plan ahead for its estimated completion.
Considerations
- What capabilities are critical vs nice-to-have?
- What capabilities have the biggest impact?
- What capabilities have the most dependencies?
- How can we scope this work in a way that delivers incremental benefits?
- What value does AQS 2.0 provide?
- What can we learn in this process that we can apply to future API Guidelines?
Requirements
- A brief description of what the use case is
- Review existing documentation
- Analyze AQS 2.0 as a product
- Review and document the API design
- Review each endpoint's success criteria
- Bullet list of what the related infrastructure capabilities are
- Define remaining known tasks including definition of done for each
- Estimate remaining tasks
- List of any potential blockers
- List of what this blocks (if anything) and why. Include examples.
- Documents and links to existing artifacts, tickets, etc. clearly organized in knowledge hub
- Open questions/additional areas to explore
Upon completion of the above:
- Tech Lead & Engineering Manager review together
- Bullet list of potential/expected development/engineering impacts (both positive and negative)
- Bullet list of potential/expected design impacts (both positive and negative)
- Describe WHAT phases or chunks of work could be done and by WHO
- List any dependencies we have on any tools, teams, etc.
- Meeting set to review scope with Product Manager
- Once scope completed and agreed to, next steps defined (ex: create Epic w/ subtasks)
Acceptance criteria
- It is clear to see how the target capability impacts end-users
- It is clear how the target capability impacts WMF staff
- Impact can be delivered incrementally, without having to wait months or to the end of a project to see impact
- Non-technical audiences can understand why this work matters and how it impacts the community
- Done is clearly defined to the best of our current limits of knowledge
Documentation and research links
https://wikitech.wikimedia.org/wiki/AQS_2.0
AQS 2.0 Research & Discovery
AQS 2.0 Task Cleanup - Sept 2022