Deliverables
Describes our process for prioritizing, planning, and completing deliverables within the Simpler.Grants.gov initiative.
Note on terminology
This section references 30k and 10k deliverables. For more information about what these terms mean and how we use them to describe the product roadmap at different levels of granularity, visit the terminology and product roadmap section of the wiki.
Planning process
In addition to tracking our deliverables in a GitHub-based product roadmap, we use this section of the wiki to plan upcoming deliverables in greater detail.
Key Steps
Create an issue: We beginning planning for a new feature by creating an using the 30k deliverable issue template, which describes the feature at a 30,000 foot view.
Draft a specification: Next, we create a change request to draft a new specification for this deliverable using the deliverable specification template.
Approve the specification: Once the team reviews and approves the change request, the new deliverable specification will appear in the specifications section of the public wiki.
Break work into 10k ft deliverables: Next, we begin breaking out this 30k deliverable into a series of issues that describe the work that needs to be completed at a 10,000 foot view using the 10k deliverable issue template.
Create a delivery schedule: The engineering team then estimates a delivery date and creates issues that describe individual tasks that are required to complete this deliverable.
Track and monitor delivery: The team will typically track these tasks in a series of GitHub milestones that map to the 10k deliverables described under the 30k deliverables.
Deliverable status
In the product roadmap and in this section of the wiki, we categorize 30k deliverables into a series of statuses. The following table describes what these statuses mean and indicates whether deliverables with this status will be included in reporting.
Status | Description | Included in reporting? |
---|---|---|
Backlog | Deliverable has been identified as a potential feature or need, but we will not be planning or working on it in the near future. | No |
Prioritized | The team has agreed to prioritize this deliverable for the next round of planning and we have begun thinking about the scope and goals. | No |
Planning | Deliverable is still being planned, meaning we are actively revising scope and haven't yet estimated a target delivery date. Note: During this phase, some work may start on the deliverable. | Yes |
In Progress | Deliverable is actively being worked on and we have estimated a target delivery date. We may cut existing scope to hit our delivery target, but should not add new scope at this point. | Yes |
Done | All of the items in outlined in the "definition of done" for the deliverable specification have been completed and the corresponding GitHub issue is closed. | No |
Deliverables specifications
A deliverable specification is an in depth planning document that identifies key assumptions, dependencies, and acceptance criteria for a 30k deliverable.
Resources
Template: Template used when drafting new deliverable specifications.
Specifications: Section of the wiki that stores an archive of deliverable specifications.
Steps to draft a new deliverable spec
Project maintainers should following these steps when drafting a new deliverable spec:
Create a new change request in this GitBook space.
Within the change request, duplicate the [Specification Template] page by clicking on the three dots to the right of page in the table of contents and selecting "duplicate".
Move the duplicated page (it should be named "Copy of [Specification Template]") under the Specifications sub-section and replace the title with the name of the 30k deliverable.
Update the sections of the deliverable specification according to the guidance in the template.
When the specification is ready for review, submit the change request and schedule an in-person meeting to review the spec with the team.
Once the specification has been reviewed with the team and approved, merge the change request and begin planning work in GitHub.
Change log
Major updates to the content of this page will be added here.
Date | Update | Notes |
---|---|---|
2/12/2024 | Initial Content | Updated with Initial content |
Last updated