diff --git a/skills/feature-refinement/INSTALLATION.md b/skills/feature-refinement/INSTALLATION.md new file mode 100644 index 0000000..3b927d6 --- /dev/null +++ b/skills/feature-refinement/INSTALLATION.md @@ -0,0 +1,194 @@ +# Feature Refinement Skill - Installation Guide + +## Overview + +This directory contains a complete Anthropic skill for guiding users through the Red Hat AI feature refinement process. + +## Skill Structure + +``` +.claude/skills/feature-refinement/ +├── SKILL.md # Main skill definition (required) +├── REFERENCE.md # Complete template reference +├── TEMPLATE.md # Blank template for document generation +└── README.md # Usage documentation +``` + +## Installation Options + +### Option 1: Project-Specific Installation (Recommended for Teams) + +The skill is already set up in this project at `.claude/skills/feature-refinement/`. + +To use it in your project: + +1. **Copy to your project:** + ```bash + cp -r .claude /path/to/your/project/ + ``` + +2. **Commit to version control:** + ```bash + git add .claude/skills/feature-refinement/ + git commit -m "Add feature refinement skill" + ``` + +This makes the skill available to anyone working on the project. + +### Option 2: Personal Installation (Available Across All Projects) + +To use this skill in all your Claude Code sessions: + +1. **Copy to your personal Claude directory:** + ```bash + mkdir -p ~/.claude/skills/ + cp -r .claude/skills/feature-refinement ~/.claude/skills/ + ``` + +2. **Verify installation:** + ```bash + ls -la ~/.claude/skills/feature-refinement/ + ``` + +You should see: +``` +SKILL.md +REFERENCE.md +TEMPLATE.md +README.md +``` + +## Verification + +To verify the skill is properly installed: + +1. Start a Claude Code session +2. Ask: "What skills are available?" +3. Look for "feature-refinement" in the list + +Or simply test it: +``` +"Help me create a feature refinement document" +``` + +Claude should automatically invoke the feature-refinement skill. + +## Usage + +Once installed, Claude will automatically use this skill when you mention feature refinement tasks: + +**Example prompts:** +- "Create a feature refinement document for a new RHOAI feature" +- "Help me refine this feature for RHEL AI" +- "Walk me through the feature refinement process" +- "I need to document a new feature for the team" + +## What's Included + +### SKILL.md (Required) +The main skill file with: +- YAML frontmatter (name and description) +- Complete 7-step workflow +- Question prompts for gathering information +- Guidance on all template sections + +### REFERENCE.md +Comprehensive reference containing: +- Full template structure +- All required sections explained +- Roles and responsibilities +- Contact information and distribution lists +- T-shirt sizing guide + +### TEMPLATE.md +Ready-to-use template with: +- All sections pre-formatted +- Markdown/Google Doc compatible +- Checkboxes for tracking progress +- Placeholder text with guidance + +### README.md +Documentation including: +- Overview and capabilities +- Installation instructions +- Usage examples +- Tips for best results +- Support contacts + +## Customization + +To adapt this skill for your organization: + +1. **Edit SKILL.md:** + - Update the description in YAML frontmatter + - Modify questions and workflow steps + - Adjust guidance for your process + +2. **Edit REFERENCE.md:** + - Change contact emails + - Update distribution lists + - Modify T-shirt sizing scales + - Add organization-specific sections + +3. **Edit TEMPLATE.md:** + - Adjust table formats + - Add/remove sections + - Update checklist items + +## Requirements + +- Claude Code CLI +- Skills feature enabled (available in recent Claude Code versions) + +## Troubleshooting + +**Skill not appearing:** +- Verify SKILL.md exists and has proper YAML frontmatter +- Check that the name field contains only lowercase letters, numbers, and hyphens +- Ensure description is under 1024 characters +- Restart Claude Code session + +**Skill not triggering automatically:** +- Try explicitly mentioning "feature refinement" in your request +- Ask "Use the feature-refinement skill to help me..." +- Check that the description accurately reflects when to use the skill + +**File permission issues:** +```bash +chmod -R 755 ~/.claude/skills/feature-refinement/ +``` + +## Support + +For questions about: +- **This skill**: Review README.md in the skill directory +- **Claude Code skills system**: Visit https://docs.claude.com/en/docs/claude-code/skills +- **Feature refinement process**: Contact team-ai-core-platform@redhat.com + +## Version Information + +- **Created**: 2025-11-12 +- **Compatible with**: Claude Code Skills system +- **Target Products**: RHOAI, RHAIIS, RHEL AI + +## Next Steps + +After installation: + +1. ✅ Verify the skill is recognized by Claude +2. ✅ Test with a sample feature refinement +3. ✅ Customize for your organization (optional) +4. ✅ Share with team members (if using project installation) +5. ✅ Review REFERENCE.md for complete template details + +## File Manifest + +``` +.claude/skills/feature-refinement/SKILL.md - Main skill definition +.claude/skills/feature-refinement/REFERENCE.md - Complete reference guide +.claude/skills/feature-refinement/TEMPLATE.md - Blank document template +.claude/skills/feature-refinement/README.md - Usage documentation +``` + +Total files: 4 +Total size: ~30KB diff --git a/skills/feature-refinement/README.md b/skills/feature-refinement/README.md new file mode 100644 index 0000000..225fa77 --- /dev/null +++ b/skills/feature-refinement/README.md @@ -0,0 +1,142 @@ +# Feature Refinement Skill + +A Claude Code skill for guiding users through the Red Hat AI feature refinement process. + +## Overview + +This skill helps Product Managers, Engineering Managers, and other stakeholders create comprehensive feature refinement documents for Red Hat AI products (RHOAI, RHAIIS, RHEL AI). It follows the official Feature Refinement Template and ensures all required sections, dependencies, and approval processes are properly documented. + +## Installation + +### For Project-Specific Use +This skill is already located in the project directory: +``` +.claude/skills/feature-refinement/ +``` + +### For Personal Use (Available Across All Projects) +Copy the skill to your personal Claude skills directory: + +```bash +mkdir -p ~/.claude/skills/ +cp -r .claude/skills/feature-refinement ~/.claude/skills/ +``` + +## Usage + +Claude will automatically invoke this skill when you mention feature refinement tasks. You can also explicitly ask Claude to use it: + +**Examples:** +- "Help me create a feature refinement document for a new RHOAI feature" +- "I need to refine a feature for RHEL AI" +- "Walk me through the feature refinement process" +- "Use the feature refinement skill to document this new capability" + +## What This Skill Does + +The skill guides you through a comprehensive 7-step process: + +1. **Gather Initial Information** - Collects basic feature metadata (Jira link, owners, product) +2. **Define Feature Details** - Documents overview, requirements, acceptance criteria, risks +3. **Verify Prerequisites & Dependencies** - Checks build onboarding, licensing, accelerator support, architecture review needs +4. **Create High-Level Delivery Plan** - Builds team delivery table with effort estimates +5. **Documentation and UXD Engagement** - Ensures proper engagement with Docs and UX teams +6. **Generate Document** - Creates the complete feature refinement document +7. **Feature Owner Next Steps** - Provides checklist for announcement, review, and approval + +## Key Features + +- **Interactive Guidance**: Asks clarifying questions to gather all required information +- **Format Templates**: Provides proper formatting for user stories (As a/I want/So that) and acceptance criteria (Given/When/Then) +- **Dependency Tracking**: Ensures all prerequisites are identified (build onboarding, licensing, AIPCC, architecture review) +- **Team Coordination**: Helps build comprehensive team delivery plans with effort estimates +- **Stakeholder Management**: Includes complete email distribution lists and engagement processes +- **Process Compliance**: Follows official Red Hat AI feature refinement workflow + +## File Structure + +``` +.claude/skills/feature-refinement/ +├── SKILL.md # Main skill definition with step-by-step workflow +├── REFERENCE.md # Complete template reference and detailed guidance +└── README.md # This file +``` + +## Products Supported + +- **RHOAI** (Red Hat OpenShift AI) + - Managed + - Self-managed +- **RHAIIS** (Red Hat AI Infrastructure Services) +- **RHEL AI** (Red Hat Enterprise Linux AI) + +## T-Shirt Size Reference + +The skill uses standard sprint-based sizing: +- **XS**: < 1 sprint +- **S**: 1 sprint (3 weeks) +- **M**: 2 sprints (6 weeks) +- **L**: 3 sprints (9 weeks) - Consider breaking down +- **XL**: 4 sprints (12 weeks) - Must break down + +## Key Contacts & Teams + +The skill includes contact information and distribution lists for: +- Documentation team +- UXD team (Jenn Giardino, Beau Morley) +- Core platform team (team-ai-core-platform@redhat.com) +- All relevant stakeholder groups + +## Prerequisites Knowledge + +The skill references several important processes: +- JIRA epic/feature linking +- AIPCC package request process (AIPCC-1) +- Build onboarding epics (RHOAIENG-31244, RHOAIENG-31290, RHOAIENG-31303) +- Architecture review requirements +- Docs intake process + +## Output Format + +The skill can generate the feature refinement document in: +- **Google Doc format** (recommended for collaboration) +- **Markdown format** (for version control) + +Both formats include all required sections, tables, and proper formatting. + +## Tips for Best Results + +1. **Have Information Ready**: Gather your Jira link, feature description, and key stakeholders before starting +2. **Be Specific**: Provide detailed answers for feature overview and requirements +3. **Think Cross-Team**: Consider all teams that might be impacted +4. **Use Provided Formats**: Leverage the user story and acceptance criteria templates +5. **Don't Skip Prerequisites**: Complete all dependency checks (build, licensing, AIPCC, architecture) +6. **Engage Early**: Include Docs and UXD teams from the beginning + +## Customization + +To modify this skill for your organization: +1. Edit `SKILL.md` to adjust the workflow or questions +2. Update `REFERENCE.md` with your template structure +3. Change contact emails and distribution lists as needed +4. Adjust T-shirt sizing scales if you use different sprint lengths + +## Related Documentation + +- [Feature Refinement Documents Folder](https://drive.google.com/drive/folders/1SZjUobSqm4t8etx9nVY0agPhH4Wu0IuS?usp=drive_link) +- [Docs Intake Process](https://docs.google.com/document/d/1G_LKipII0DMX3UxpkxVEpgM9Pk5tHcfZdvnkjn9E1mI/edit?tab=t.0) +- Build Onboarding Epics: RHOAIENG-31244 (DevPreview), RHOAIENG-31290 (TechPreview), RHOAIENG-31303 (GA) +- AIPCC Package Requests: AIPCC-1 + +## Support + +For questions about: +- **Build Process**: team-ai-core-platform@redhat.com +- **UX Design**: Jenn Giardino (jgiardin@redhat.com) or Beau Morley (bmorley@redhat.com) +- **Documentation**: openshift-ai-docs@redhat.com +- **AIPCC/Accelerators**: Follow AIPCC-1 process + +## Version + +Created: 2025-11-12 +Compatible with: Claude Code Skills system diff --git a/skills/feature-refinement/REFERENCE.md b/skills/feature-refinement/REFERENCE.md new file mode 100644 index 0000000..34b22d3 --- /dev/null +++ b/skills/feature-refinement/REFERENCE.md @@ -0,0 +1,227 @@ +# Feature Refinement Template Reference + +This reference contains the complete feature refinement template structure for Red Hat AI products. + +## Document Naming Convention + +Format: `FeatureRefinement - Jira# - TITLE OF STRAT` + +## Document Header Table + +| Field | Value | +|-------|-------| +| Feature Jira Link | | +| Status | Not started / In Progress / Approved | +| Slack Channel / Thread | | +| Feature Owner | Person | +| Delivery Owner | Person | +| RFE Council Reviewer | Person | +| Product | | + +## Feature Details Sections + +### 1. Feature Overview +Description of feature. Answer: +- Who (which persona/user role) benefits from this feature, and how? +- What is the difference between today's current state and a world with this feature? +- High level user narrative: How and when would the user use this functionality? + +### 2. The Why +- Why are we doing this feature now? +- What will this bring to the platform? +- How will it help us win customers? +- What types of customers will benefit? +- What supporting data do we have? +- If assumptive and not data-driven, provide clear success metrics + +### 3. High Level Requirements +List of functionality delivered through this feature, focusing on mandatory requirements for initial release. + +**Suggested format:** +- As a [user role/persona] +- I want [capability/feature] +- So that [benefit/business value] + +### 4. Non-Functional Requirements +List non-functional requirements such as: +- Performance parameters +- Security concerns or areas to watch +- Special considerations for disconnected environments +- User expectations +- Upgrade from previous release considerations + +### 5. Out-of-Scope +Define the boundaries of the feature. List items that are Out-of-Scope. + +### 6. Acceptance Criteria +What must be true for this feature to be considered complete? Document clear, testable outcomes that define "done." + +**Suggested format:** +- Given [context or precondition] +- When [action taken] +- Then [expected outcome] + +### 7. Risks & Assumptions +- **Risks**: Potential blockers or threats to successful delivery +- **Assumptions**: Conditions believed to be true but needing validation + +### 8. Supporting Documentation +Provide links (not copies) to: +- Designs +- Workflows +- Wireframes +- Discovery notes +- Technical documentation + +### 9. Additional Clarifying Information +Add any other information that would further clarify the requirement and aid delivery teams in understanding the full context. + +## New Feature/Component Prerequisites & Dependencies + +### ODH/RHOAI Build Process Onboarding +**Will this feature require onboarding of a new container Image or component?** YES / NO + +If YES, follow these instructions and email team-ai-core-platform@redhat.com: +- **DevPreview**: Clone RHOAIENG-31244 +- **TechPreview**: Clone RHOAIENG-31290 +- **GA**: Clone RHOAIENG-31303 + +### License Validation +**Will this feature require bringing in new upstream projects or sub-projects?** YES / NO + +If YES: +- Check licensing for the project (preference: Apache 2.0) +- If Apache License cannot be obtained, post specific reason and required license in forum-openshift-ai-architecture for approval + +### Accelerator/Package Support +**Does this feature require support from the AIPCC team?** YES / NO + +Questions to identify: +- Are there any new or updated package requests? + - If yes, follow instructions in AIPCC-1 and clone/populate the ticket + - Attach the new epic to the STRAT feature +- Which accelerators should be supported or is this for a new accelerator? +- Any other AIPCC work needed (new variant, new image for RHAIIS, etc.)? + - Open a new Feature in the AIPCC project + - Fill in the template + - Attach Feature to RHAISTRAT issue with "depends on" issue link + +### Architecture Review Check +- **Does the feature have the label "requires_architecture_review"?** YES / NO +- **Does the related RFE indicate "Requires architecture review: YES"?** YES / NO + +If YES to either: +- Feature design MUST be reviewed at the OpenShift AI Architecture Forum before the team commits to a specific solution +- This ensures alignment with overall product vision and provides architectural visibility +- Teams may still conduct spikes or research activities prior to formal review + +### Additional Dependencies +Include any other prerequisites or dependencies needed to deliver this feature. + +## High Level Plan + +### Team Delivery Table + +| Team | Start Date | Work to Deliver (EPIC) | Team Dependencies | T-Shirt Size | Approval/Comments | +|------|------------|------------------------|-------------------|--------------|-------------------| +| team-ai-core-platform | | | | | | +| [Additional teams...] | | | | | | + +**Team Dependencies**: Describe any support, work, or input needed from other teams + +**T-Shirt Size Estimate Scale:** +- **XS**: < 1 sprint +- **S**: 1 sprint (3 weeks) +- **M**: 2 sprints (6 weeks) +- **L**: 3 sprints (9 weeks) - Highly recommend breaking down into multiple features +- **XL**: 4 sprints (12 weeks) - Too big! Break it down! + +*Note: Do not include time spent waiting on upstream or other teams, just the size of work done by OpenShift AI stakeholders.* + +**Approval/Comments**: Add name/date if approved or note what is needed + +## Engaging Documentation and UXD Teams + +### Documentation Team +1. Add "Documentation" component to the feature +2. Set "Product Documentation Required" field to Yes +3. Add docs team to the High Level Plan table +4. Review the [Docs Intake Process](https://docs.google.com/document/d/1G_LKipII0DMX3UxpkxVEpgM9Pk5tHcfZdvnkjn9E1mI/edit?tab=t.0) +5. Flag any new features and enhancements for Release Notes + +### UXD Team +1. Add "UXD" component to the feature +2. Add UXD team to the High Level Plan table +3. Reach out to: + - Jenn Giardino: jgiardin@redhat.com + - Beau Morley: bmorley@redhat.com + +## Feature Owner Responsibilities + +### Initial Setup +1. Link feature refinement document in Jira Feature +2. [Optional] Create public Slack channel for cross-team discussion +3. Collaborate with team leads to confirm POCs from each team +4. Update document status to "In Progress" + +### Communication +Announce the feature via email to: +- All teams responsible for impacted components +- aipcc-eng-directs +- inference-ai-eng +- team-psap@redhat.com +- team-ai-core-platform@redhat.com +- ai-bu@redhat.com +- openshift-ai-docs@redhat.com +- ai-ux-all@redhat.com +- rhai-service-teams@redhat.com +- openshift-ai-devtestops@redhat.com +- openshift-ai-qe@redhat.com +- dramseur@redhat.com + +### Review Process +1. Schedule meeting to review refinement document with delivery teams +2. Answer questions and discuss risks/concerns +3. Team members submit questions via document comments or Slack +4. Complete team review and define high-level delivery plan +5. Ensure every contributing team defines at least one Epic + +### Finalization +1. Verify all impacted components are listed in Jira Feature's Components field +2. Remind teams to populate Epic's Parent Link field with Feature link +3. Address all comments and update document +4. Confirm team approvals in Approval/Comments column +5. Set document status to "Approved" +6. Change permissions to Read-Only + +## Delivery Owner Responsibilities + +### Accepting Work +1. Agree to the "why" and "what" is to be delivered +2. Coordinate creation of tracked work for all participating teams +3. Ensure all participating teams have signed off +4. Verify Definition of Ready has been met + +### Communication +1. Announce to broader organization that feature development will begin + +## Key Feature Owner Tasks Summary + +| Task | Responsible | +|------|-------------| +| Clarify requirements and define "why" | Feature Owner | +| Provide detailed user stories and specs | Feature Owner | +| Set up review meetings | Feature Owner | +| Collaborate with development teams | Feature Owner | +| Manage stakeholder expectations | Feature Owner | +| Act as primary stakeholder contact | Feature Owner | +| Announce new features | Feature Owner | +| Agree to scope and deliverables | Delivery Owner | +| Coordinate tracked work creation | Delivery Owner | +| Ensure team sign-off and Definition of Ready | Delivery Owner | +| Announce feature development start | Delivery Owner | + +## Document Storage + +Add your feature refinement document to the feature refinement documents folder: +[Feature Refinement Documents Folder](https://drive.google.com/drive/folders/1SZjUobSqm4t8etx9nVY0agPhH4Wu0IuS?usp=drive_link) diff --git a/skills/feature-refinement/SKILL.md b/skills/feature-refinement/SKILL.md new file mode 100644 index 0000000..91b293e --- /dev/null +++ b/skills/feature-refinement/SKILL.md @@ -0,0 +1,224 @@ +--- +name: feature-refinement +description: Guides users through the complete feature refinement process for Red Hat AI products (RHOAI, RHAIIS, RHEL AI). Creates a structured feature refinement document with all required sections including feature overview, requirements, dependencies, team plans, and approval tracking. Use when users need to refine, document, or plan a new product feature. +--- + +# Feature Refinement Skill + +This skill helps you create a comprehensive feature refinement document following Red Hat AI's template and process. + +## When to Use This Skill + +Use this skill when: +- Creating a new feature refinement document for RHOAI, RHAIIS, or RHEL AI +- Documenting feature requirements and acceptance criteria +- Planning cross-team feature delivery +- Preparing features for engineering review + +## Feature Refinement Process + +### Step 1: Gather Initial Information + +Ask the user for the following information to populate the feature refinement document: + +**Required Information:** +1. **Feature Jira Link** - Link to the STRAT feature (XXXSTRAT-####) +2. **Feature Title** - Name of the feature for the document title +3. **Product** - RHOAI (managed or self-managed), RHAIIS, or RHEL AI +4. **Feature Owner** - Person responsible for requirements (typically Product Manager) +5. **Delivery Owner** - Person responsible for delivery (typically Engineering Manager or Staff Architect) + +**Optional Information:** +- Slack Channel/Thread for discussion +- RFE Council Reviewer + +### Step 2: Define Feature Details + +Work with the user to complete each section. Ask clarifying questions as needed: + +#### Feature Overview +- Who benefits from this feature (persona/user role)? +- What is the current state vs. the desired state with this feature? +- High-level user narrative: How and when would users use this functionality? + +#### The Why +- Why now? What business value does this bring? +- What types of customers will benefit? +- What supporting data exists? +- If assumptive (not data-driven), what are the success metrics? + +#### High Level Requirements +Format as user stories: +- As a [user role/persona] +- I want [capability/feature] +- So that [benefit/business value] + +Focus only on mandatory requirements for initial release. + +#### Non-Functional Requirements +Consider: +- Performance parameters +- Security concerns +- Disconnected environment requirements +- User expectations +- Upgrade considerations from previous releases + +#### Out-of-Scope +Define clear boundaries - what is NOT included in this feature. + +#### Acceptance Criteria +Format as Given-When-Then: +- Given [context or precondition] +- When [action taken] +- Then [expected outcome] + +#### Risks & Assumptions +- **Risks**: Potential blockers or threats to delivery +- **Assumptions**: Conditions believed true but needing validation + +#### Supporting Documentation +Gather links to: +- Designs and wireframes +- Workflows and user flows +- Discovery notes +- Technical documentation + +### Step 3: Verify Prerequisites & Dependencies + +Check and document the following: + +#### New Feature/Component Prerequisites + +1. **ODH/RHOAI Build Process Onboarding** + - Will this require a new container image or component? (YES/NO) + - If YES, reference onboarding epics: + - DevPreview: RHOAIENG-31244 + - TechPreview: RHOAIENG-31290 + - GA: RHOAIENG-31303 + - Email: team-ai-core-platform@redhat.com for questions + +2. **License Validation** + - Will this bring in new upstream projects/sub-projects? (YES/NO) + - If YES: Verify licensing (preference: Apache 2.0) + - If non-Apache: Post justification in forum-openshift-ai-architecture + +3. **Accelerator/Package Support** + - Does this require AIPCC team support? (YES/NO) + - New/updated package requests? Follow AIPCC-1 instructions + - Which accelerators should be supported? + - Create AIPCC Feature and link with "depends on" + +4. **Architecture Review Check** + - Does feature have "requires_architecture_review" label? (YES/NO) + - Does RFE indicate "Requires architecture review: YES"? (YES/NO) + - If YES to either: Must be reviewed at OpenShift AI Architecture Forum before commitment + +5. **Additional Dependencies** + - Document any other prerequisites needed + +### Step 4: Create High-Level Delivery Plan + +Build a table with the following for each team involved: + +| Team | Start Date | Work to Deliver (EPIC) | Team Dependencies | T-Shirt Size | Approval/Comments | +|------|------------|------------------------|-------------------|--------------|-------------------| + +**T-Shirt Size Scale:** +- XS: < 1 sprint +- S: 1 sprint (3 weeks) +- M: 2 sprints (6 weeks) +- L: 3 sprints (9 weeks) - Consider breaking down +- XL: 4 sprints (12 weeks) - Too big, must break down + +**Note:** Always include team-ai-core-platform - they confirm if support is needed. + +### Step 5: Documentation and UXD Engagement + +**Documentation Team:** +- Add "Documentation" component to Jira feature +- Set "Product Documentation Required" to Yes +- Add docs team to delivery plan table +- Review [Docs Intake Process](https://docs.google.com/document/d/1G_LKipII0DMX3UxpkxVEpgM9Pk5tHcfZdvnkjn9E1mI/edit?tab=t.0) +- Flag for Release Notes if needed + +**UXD Team:** +- Add "UXD" component to Jira feature +- Add UXD team to delivery plan table +- Contact: Jenn Giardino (jgiardin@redhat.com) or Beau Morley (bmorley@redhat.com) + +### Step 6: Generate Document + +Create a Google Doc or Markdown file with the complete feature refinement document using the gathered information. + +**Document Status Flow:** +1. Start: "Not started" +2. During refinement: "In Progress" +3. After approval: "Approved" (set to Read-Only) + +### Step 7: Feature Owner Next Steps + +Remind the user of these follow-up actions: + +1. **Link & Share:** + - Link document in Jira Feature + - Create public Slack channel for collaboration (optional) + - Announce via email to all stakeholder teams + +2. **Email Distribution List:** + - All teams for impacted components + - aipcc-eng-directs + - inference-ai-eng + - team-psap@redhat.com + - team-ai-core-platform@redhat.com + - ai-bu@redhat.com + - openshift-ai-docs@redhat.com + - ai-ux-all@redhat.com + - rhai-service-teams@redhat.com + - openshift-ai-devtestops@redhat.com + - openshift-ai-qe@redhat.com + - dramseur@redhat.com + +3. **Schedule Review Meeting:** + - Review with all delivery teams + - Answer questions and discuss risks/concerns + - Use document comments or Slack for questions + +4. **Finalize:** + - Complete team reviews and delivery plan + - Verify all components listed in Jira + - Ensure EPICs have Parent Link to Feature + - Address all comments + - Get team approvals (Approval/Comments column) + - Update document status to "Approved" + - Set to Read-Only + +## Key Roles & Responsibilities + +**Feature Owner (typically Product Manager):** +- Define and clarify requirements +- Communicate the "why" behind the work +- Set up review meetings +- Manage stakeholder expectations +- Act as primary stakeholder contact +- Announce new features + +**Delivery Owner (typically Engineering Manager/Staff Architect):** +- Agree to scope and deliverables +- Coordinate tracked work creation for all teams +- Ensure team sign-off and Definition of Ready +- Announce feature development start + +## Tips for Success + +- Be clear and specific in requirements +- Use the suggested formats (user stories, Given-When-Then) +- Break down large features (> 3 sprints) +- Verify all prerequisites early +- Engage documentation and UX teams early +- Get explicit team approvals before marking "Approved" +- Link all related epics properly in Jira +- Keep stakeholders informed throughout + +## Output Format + +Generate the feature refinement document in a structured format (Google Doc template or Markdown) with all sections populated based on the user's input. Use tables where specified in the template. diff --git a/skills/feature-refinement/TEMPLATE.md b/skills/feature-refinement/TEMPLATE.md new file mode 100644 index 0000000..e8102f6 --- /dev/null +++ b/skills/feature-refinement/TEMPLATE.md @@ -0,0 +1,231 @@ +# Feature Refinement Document Template + +**Document Title:** FeatureRefinement - [JIRA#] - [TITLE] + +--- + +## Feature Metadata + +| Field | Value | +|-------|-------| +| **Feature Jira Link** | [Link to XXXSTRAT-####] | +| **Slack Channel / Thread** | [Link or N/A] | +| **Feature Owner** | [Name] | +| **Delivery Owner** | [Name] | +| **RFE Council Reviewer** | [Name] | +| **Product** | [RHOAI (managed/self-managed) / RHAIIS / RHEL AI] | +| **Status** | Not started | + +--- + +## Feature Details + +### Feature Overview + +[Description of feature. Answer the following: +- Who (which persona/user role) benefits from this feature, and how? +- What is the difference between today's current state and a world with this feature? +- High level user narrative: Tell how the user would use this functionality and when they would use it.] + +### The Why + +[Why are we doing this feature now? What will this bring to the platform, how will it help us win customers, and what types of customers will benefit from it? What supporting data do we have? If this is assumptive and not data-driven, provide clear success metrics for validating assumptions.] + +### High Level Requirements + +*Format: As a [user role/persona], I want [capability/feature], So that [benefit/business value]* + +1. As a [persona], I want [capability], So that [benefit] +2. As a [persona], I want [capability], So that [benefit] +3. [Add more as needed] + +### Non-Functional Requirements + +- **Performance**: [Performance parameters and expectations] +- **Security**: [Security concerns or areas to watch] +- **Disconnected Environments**: [Special considerations if applicable] +- **User Expectations**: [User experience requirements] +- **Upgrade Considerations**: [Considerations from previous releases] +- [Add others as needed] + +### Out-of-Scope + +[Define the boundaries of the feature. List items that are Out-of-Scope:] + +- [Out-of-scope item 1] +- [Out-of-scope item 2] +- [Add more as needed] + +### Acceptance Criteria + +*Format: Given [context or precondition], When [action taken], Then [expected outcome]* + +1. **Given** [context], **When** [action], **Then** [outcome] +2. **Given** [context], **When** [action], **Then** [outcome] +3. [Add more as needed] + +### Risks & Assumptions + +**Risks:** *Potential blockers or threats to successful delivery* +- [Risk 1] +- [Risk 2] +- [Add more as needed] + +**Assumptions:** *Conditions believed to be true but needing validation* +- [Assumption 1] +- [Assumption 2] +- [Add more as needed] + +### Supporting Documentation + +- Design: [Link] +- Workflows: [Link] +- Wireframes: [Link] +- Discovery Notes: [Link] +- Technical Documentation: [Link] +- [Add others as needed] + +### Additional Clarifying Information + +[Add any other information that would further clarify the requirement and aid the delivery teams in understanding the full context of this request.] + +--- + +## New Feature / Component Prerequisites & Dependencies + +### ODH/RHOAI Build Process Onboarding + +**Will this feature require onboarding of a new container Image or component?** ☐ YES ☐ NO + +**If YES:** +- Follow onboarding instructions for appropriate epic: + - DevPreview: Clone RHOAIENG-31244 + - TechPreview: Clone RHOAIENG-31290 + - GA: Clone RHOAIENG-31303 +- Email team-ai-core-platform@redhat.com for questions + +### License Validation + +**Will this feature require bringing in new upstream projects or sub-projects into the product?** ☐ YES ☐ NO + +**If YES:** +- License type: [Apache 2.0 preferred] +- If not Apache 2.0, justification: [Explain and post to forum-openshift-ai-architecture] + +### Accelerator/Package Support + +**Does this feature require support from the AIPCC team?** ☐ YES ☐ NO + +**If YES:** +- New/updated package requests: [Details - follow AIPCC-1 process] +- Accelerators to support: [List accelerators] +- Other AIPCC work needed: [Describe and create AIPCC Feature] + +### Architecture Review Check + +**Does the feature have the label "requires_architecture_review"?** ☐ YES ☐ NO + +**Does the related RFE indicate "Requires architecture review: YES"?** ☐ YES ☐ NO + +**If YES to either:** +- ⚠️ Feature design MUST be reviewed at the OpenShift AI Architecture Forum before committing to a solution +- Teams may conduct spikes/research before formal review + +### Additional Dependencies + +[Include any other prerequisites or dependencies needed to deliver this feature] + +--- + +## High Level Plan + +### Teams Involved in Feature Delivery + +| Team | Start Date | Work to Deliver (EPIC) | Team Dependencies | T-Shirt Size | Approval/Comments | +|------|------------|------------------------|-------------------|--------------|-------------------| +| team-ai-core-platform | [Date] | [EPIC link/description] | [Dependencies] | [XS/S/M/L/XL] | [Name/Date or What's needed] | +| [Team Name] | [Date] | [EPIC link/description] | [Dependencies] | [XS/S/M/L/XL] | [Name/Date or What's needed] | +| [Team Name] | [Date] | [EPIC link/description] | [Dependencies] | [XS/S/M/L/XL] | [Name/Date or What's needed] | + +**T-Shirt Size Scale:** +- **XS**: < 1 sprint +- **S**: 1 sprint (3 weeks) +- **M**: 2 sprints (6 weeks) +- **L**: 3 sprints (9 weeks) - Highly recommend breaking down +- **XL**: 4 sprints (12 weeks) - Too big! Break it down! + +*Note: Do not include time waiting on upstream or other teams* + +--- + +## Documentation and UXD Engagement + +### Documentation Team Engagement + +- [ ] Added "Documentation" component to the feature +- [ ] Set "Product Documentation Required" field to Yes +- [ ] Added docs team to High Level Plan table +- [ ] Reviewed [Docs Intake Process](https://docs.google.com/document/d/1G_LKipII0DMX3UxpkxVEpgM9Pk5tHcfZdvnkjn9E1mI/edit?tab=t.0) +- [ ] Flagged for Release Notes (if applicable) + +### UXD Team Engagement + +- [ ] Added "UXD" component to the feature +- [ ] Added UXD team to High Level Plan table +- [ ] Contacted: + - ☐ Jenn Giardino (jgiardin@redhat.com) + - ☐ Beau Morley (bmorley@redhat.com) + +--- + +## Feature Owner Checklist + +### Initial Setup +- [ ] Linked this document in the Jira Feature +- [ ] Created public Slack channel (if needed): [Link] +- [ ] Confirmed POCs from each team +- [ ] Updated status to "In Progress" + +### Communication +- [ ] Announced feature via email to all stakeholder teams +- [ ] Scheduled review meeting with delivery teams + +### Email Distribution Checklist +Ensure the following teams are included: +- [ ] All teams responsible for impacted components +- [ ] aipcc-eng-directs +- [ ] inference-ai-eng +- [ ] team-psap@redhat.com +- [ ] team-ai-core-platform@redhat.com +- [ ] ai-bu@redhat.com +- [ ] openshift-ai-docs@redhat.com +- [ ] ai-ux-all@redhat.com +- [ ] rhai-service-teams@redhat.com +- [ ] openshift-ai-devtestops@redhat.com +- [ ] openshift-ai-qe@redhat.com +- [ ] dramseur@redhat.com + +### Finalization +- [ ] All impacted components listed in Jira Feature's Components field +- [ ] All teams populated Epic's Parent Link field with Feature link +- [ ] All comments addressed +- [ ] All teams approved (check Approval/Comments column) +- [ ] Updated status to "Approved" +- [ ] Set document permissions to Read-Only +- [ ] Uploaded to [Feature Refinement Documents Folder](https://drive.google.com/drive/folders/1SZjUobSqm4t8etx9nVY0agPhH4Wu0IuS?usp=drive_link) + +--- + +## Delivery Owner Checklist + +- [ ] Reviewed and agreed to scope and deliverables +- [ ] Coordinated tracked work creation for all teams +- [ ] Ensured all teams signed off +- [ ] Verified Definition of Ready is met +- [ ] Announced feature development start to organization + +--- + +**Document Status:** [Not started / In Progress / Approved] + +**Last Updated:** [Date]