Created
September 12, 2025 05:29
-
-
Save GJivan/92bba3ef7e5a622be2f2a25adab63204 to your computer and use it in GitHub Desktop.
Feature biref
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| # Feature Brief Template & AI Prompts for VS Code | |
| This document contains a template for a detailed "Feature Brief" and a series of prompts to use with GitHub Copilot Chat to analyze requirements and generate user stories for Azure DevOps. | |
| --- | |
| ## Part 1: Feature Brief Template | |
| *Create a new file named `feature-brief.md` in your VS Code workspace and paste the following template into it. Fill it out with the specifics of your feature.* | |
| ```markdown | |
| ### Feature: [Your Feature Name Here] | |
| **ADO Project:** [Your Azure DevOps Project Name] | |
| **ADO Work Item ID:** #[Your Work Item ID] | |
| **ADO Work Item Link:** [Link to the Feature/Epic in Azure DevOps] | |
| #### 1. Problem Statement | |
| * **Who is the user?** (e.g., "As a site administrator...", "As an API consumer...") | |
| * **What is the pain point?** (e.g., "...I cannot efficiently bulk-update user permissions...") | |
| * **What is the desired outcome?** (e.g., "...so that I can save time when onboarding a new team.") | |
| #### 2. High-Level Solution | |
| * Describe the proposed solution at a high level. | |
| * Detail the key capabilities and user-facing changes. | |
| * Include mockups or diagrams if available. You can use Mermaid syntax for diagrams directly in the Markdown. | |
| #### 3. Scope | |
| * **In Scope:** Clearly list what this feature WILL do. | |
| * **Out of Scope:** Explicitly state what is NOT included to prevent scope creep. | |
| #### 4. Technical Context | |
| * **Impacted Repositories:** `@workspace/repo-1`, `@workspace/repo-2/src/services` | |
| * **Key Services/APIs:** List the primary microservices, APIs, or libraries that will be created or modified. | |
| * **Data Models:** Describe any new or changed database schemas or data contracts. | |
| * **Known Dependencies:** Are there dependencies on other teams, services, or external systems? | |
| #### 5. High-Level Acceptance Criteria | |
| * List the key business-level conditions that must be met for the feature to be considered "done." (e.g., "An administrator can successfully select and update permissions for multiple users at once.") | |
| #### 6. Non-Functional Requirements (Optional but Recommended) | |
| * **Performance:** (e.g., "API response times must be under 500ms.") | |
| * **Security:** (e.g., "All endpoints must be authenticated and authorized.") | |
| * **Observability:** (e.g., "Emit metrics for success/failure rates.") | |
| * **Accessibility (a11y):** (e.g., "UI must be keyboard navigable.") | |
| ``` | |
| --- | |
| ## Part 2: Copilot Chat Prompts | |
| *Use these prompts in the VS Code Copilot Chat view to analyze your feature brief and generate stories.* | |
| ### Prompt 1: ADO Sync & Compare | |
| *Use this to ensure your brief aligns with the original work item in Azure DevOps.* | |
| > "Using `@ado`, retrieve the description and acceptance criteria for work item #\[Work Item ID] in the '\[Project Name]' project. Then, compare that information with the contents of `@workspace feature-brief.md`. Identify any discrepancies, gaps, or areas where my brief provides necessary additional detail." | |
| ### Prompt 2: Sanity Check on Brief | |
| *Use this to have the AI act as a peer reviewer to find holes in your logic.* | |
| > "Now, focusing only on the `@workspace feature-brief.md` document, act as a principal software engineer. Analyze the requirements and identify potential ambiguities, contradictions, or missing information. List your findings as bullet points." | |
| ### Prompt 3: Technical Risk & Dependency Analysis | |
| *Use this to get an AI-driven analysis of potential technical challenges.* | |
| > "Considering the full context of the `@workspace` and the feature brief, analyze the technical implementation details. What are the primary technical risks? What cross-service dependencies do you foresee? Are there potential performance or security considerations I've missed?" | |
| ### Prompt 4: Generate User Stories | |
| *Once your brief is finalized, use this to generate the first draft of your user stories.* | |
| > "Using the finalized `@workspace feature-brief.md`, break the feature down into a list of user stories. For each story, provide: | |
| > 1. A concise title. | |
| > 2. A description in the format: 'As a [persona], I want to [action], so that [value].' | |
| > 3. A preliminary list of technical acceptance criteria. | |
| > | |
| > Organize the stories logically, perhaps by component or user workflow. Ensure the stories are vertically sliced to deliver incremental value." |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment