-
Feature
-
Resolution: Unresolved
-
Critical
-
None
-
None
-
None
-
False
-
-
False
-
Not Selected
Feature Overview (mandatory - Complete while in New status)
The SDG dataset is put together by systematically pairing the chunks and qna.yaml fields (the domain, document outline, contexts, qna pairs specifically).
Goals (mandatory - Complete while in New status)
Provide high-level goal statement, providing user context and expected user outcome(s) for this Feature
- Users can easily run the notebook
Requirements (mandatory -_ Complete while in Refinement status):
A list of specific needs, capabilities, or objectives that a Feature must deliver to satisfy the Feature. Some requirements will be flagged as MVP. If an MVP gets shifted, the Feature shifts. If a non MVP requirement slips, it does not shift the feature.
Requirement | Notes | isMVP? |
Generate a complete seed.jsonl file | Yes | |
Consider how we are putting together chunks and qna.yamls - if users start with multiple docs & multiple qna.yamls - how do we connect those to each other? |
||
Yes | ||
Notebook should provide workflows for both: 1. single document 2. multiple documents 3. multiple folders of documents |
Yes | |
Consider how this particular notebook’s inputs/outputs flow with the next notebook in the process - how is it all put together? Ensure file paths, output types etc are consistent |
Yes | |
Potentially a demo showing: how will this be run on RHEL AI? with Elyra? Workbench container? | No | |
Show how a user would work through a folder of documents - what happens if a user wants to generate chunks for a collection of input documents? How are chunks correlated with respective qna files? | No | |
Consider the different paths users might have used to get to this outcome: 1. User generated a qna.yaml in a previous step and expects to add it as an input or are bringing their own qna.yaml Guide users through the process - especially if there are different paths provided |
No |
Done - Acceptance Criteria (mandatory - Complete while in Refinement status):
Acceptance Criteria articulates and defines the value proposition - what is required to meet the goal and intent of this Feature. The Acceptance Criteria provides a detailed definition of scope and the expected outcomes - from a users point of view.
- Ensure it passes UX reviews ([reqs documented here|https://github.com/instructlab/examples/blob/main/Notebook-UX-Review-Template.md])
Use Cases - i.e. User Experience & Workflow: (Initial completion while in Refinement status):
Include use case diagrams, main success scenarios, alternative flow scenarios.
<your text here>
Out of Scope {}{}(Initial completion while in Refinement status):
High-level list of items or persona’s that are out of scope.
<your text here>
Documentation Considerations {}{}(Initial completion while in Refinement status):
Provide information that needs to be considered and planned so that documentation will meet customer needs. If the feature extends existing functionality, provide a link to its current documentation..
<your text here>
Questions to Answer {}{}(Initial completion while in Refinement status):
Include a list of refinement / architectural questions that may need to be answered before coding can begin.
<your text here>
Background and Strategic Fit (Initial completion while in Refinement status):
Provide any additional context is needed to frame the feature.
<your text here>
Customer Considerations {}{}(Initial completion while in Refinement status):
Provide any additional customer-specific considerations that must be made when designing and delivering the Feature.
<your text here>
Team Sign Off (Completion while in Planning status)
- All required Epics (known at the time) are linked to the this Feature
- All required Stories, Tasks (known at the time) for the most immediate Epics have been created and estimated
- Add - Reviewers name, Team Name
- Acceptance == Feature as “Ready” - well understood and scope is clear - Acceptance Criteria (scope) is elaborated, well defined, and understood
- Note: Only set FixVersion/s: on a Feature if the delivery team agrees they have the capacity and have committed that capability for that milestone
Reviewed By | Team Name | Accepted | Notes |
- …
- depends on
-
RHELAI-3935 Notebook to create dataset for SDG input
-
- Resolved
-
- is cloned by
-
RHELAI-4153 step7: Automate mixing of SDG output [L1]
-
- New
-