refactor: standardize formatting and improve readability across core documents (#211)

### CHANGES

- Add newlines and spacing for improved readability
- Standardize instructional text for consistency
- Renumber lists within tasks for better clarity
- Add language identifiers to various code blocks
- Update placeholder text for improved consistency
- Adjust descriptions and wording in multiple files
- Update VS Code settings and dictionary words
This commit is contained in:
Kayvan Sylvan
2025-06-14 06:33:59 -07:00
committed by GitHub
parent 726c3d35b6
commit 009c77f0f5
35 changed files with 515 additions and 349 deletions

View File

@@ -1,8 +1,9 @@
# Project Brief: {{Project Name}}
[[LLM: This template guides creation of a comprehensive Project Brief that serves as the foundational input for product development.
[[LLM: This template guides creation of a comprehensive Project Brief that serves as the foundational input for product development.
Start by asking the user which mode they prefer:
1. **Interactive Mode** - Work through each section collaboratively
2. **YOLO Mode** - Generate complete draft for review and refinement
@@ -11,6 +12,7 @@ Before beginning, understand what inputs are available (brainstorming results, m
## Executive Summary
[[LLM: Create a concise overview that captures the essence of the project. Include:
- Product concept in 1-2 sentences
- Primary problem being solved
- Target market identification
@@ -21,6 +23,7 @@ Before beginning, understand what inputs are available (brainstorming results, m
## Problem Statement
[[LLM: Articulate the problem with clarity and evidence. Address:
- Current state and pain points
- Impact of the problem (quantify if possible)
- Why existing solutions fall short
@@ -31,6 +34,7 @@ Before beginning, understand what inputs are available (brainstorming results, m
## Proposed Solution
[[LLM: Describe the solution approach at a high level. Include:
- Core concept and approach
- Key differentiators from existing solutions
- Why this solution will succeed where others haven't
@@ -41,15 +45,18 @@ Before beginning, understand what inputs are available (brainstorming results, m
## Target Users
[[LLM: Define and characterize the intended users with specificity. For each user segment include:
- Demographic/firmographic profile
- Current behaviors and workflows
- Specific needs and pain points
- Goals they're trying to achieve]]
### Primary User Segment: {{Segment Name}}
{{Detailed description of primary users}}
### Secondary User Segment: {{Segment Name}}
{{Description of secondary users if applicable}}
## Goals & Success Metrics
@@ -57,16 +64,19 @@ Before beginning, understand what inputs are available (brainstorming results, m
[[LLM: Establish clear objectives and how to measure success. Make goals SMART (Specific, Measurable, Achievable, Relevant, Time-bound)]]
### Business Objectives
- {{Objective 1 with metric}}
- {{Objective 2 with metric}}
- {{Objective 3 with metric}}
### User Success Metrics
- {{How users will measure value}}
- {{Engagement metrics}}
- {{Satisfaction indicators}}
### Key Performance Indicators (KPIs)
- {{KPI 1: Definition and target}}
- {{KPI 2: Definition and target}}
- {{KPI 3: Definition and target}}
@@ -76,15 +86,18 @@ Before beginning, understand what inputs are available (brainstorming results, m
[[LLM: Define the minimum viable product clearly. Be specific about what's in and what's out. Help user distinguish must-haves from nice-to-haves.]]
### Core Features (Must Have)
- **Feature 1:** {{Brief description and why it's essential}}
- **Feature 2:** {{Brief description and why it's essential}}
- **Feature 3:** {{Brief description and why it's essential}}
### Out of Scope for MVP
- {{Feature/capability explicitly not in MVP}}
- {{Feature/capability to be considered post-MVP}}
### MVP Success Criteria
{{Define what constitutes a successful MVP launch}}
## Post-MVP Vision
@@ -92,12 +105,15 @@ Before beginning, understand what inputs are available (brainstorming results, m
[[LLM: Outline the longer-term product direction without overcommitting to specifics]]
### Phase 2 Features
{{Next priority features after MVP success}}
### Long-term Vision
{{Where this product could go in 1-2 years}}
### Expansion Opportunities
{{Potential new markets, use cases, or integrations}}
## Technical Considerations
@@ -105,17 +121,20 @@ Before beginning, understand what inputs are available (brainstorming results, m
[[LLM: Document known technical constraints and preferences. Note these are initial thoughts, not final decisions.]]
### Platform Requirements
- **Target Platforms:** {{Web, mobile, desktop, etc.}}
- **Browser/OS Support:** {{Specific requirements}}
- **Performance Requirements:** {{Load times, concurrent users, etc.}}
### Technology Preferences
- **Frontend:** {{If any preferences exist}}
- **Backend:** {{If any preferences exist}}
- **Database:** {{If any preferences exist}}
- **Hosting/Infrastructure:** {{Cloud preferences, on-prem requirements}}
### Architecture Considerations
- **Repository Structure:** {{Initial thoughts on monorepo vs. polyrepo}}
- **Service Architecture:** {{Initial thoughts on monolith vs. microservices}}
- **Integration Requirements:** {{Third-party services, APIs}}
@@ -126,12 +145,14 @@ Before beginning, understand what inputs are available (brainstorming results, m
[[LLM: Clearly state limitations and assumptions to set realistic expectations]]
### Constraints
- **Budget:** {{If known}}
- **Timeline:** {{Target launch date or development timeframe}}
- **Resources:** {{Team size, skill constraints}}
- **Technical:** {{Legacy systems, required tech stack}}
### Key Assumptions
- {{Assumption about users, market, or technology}}
- {{Assumption about resources or support}}
- {{Assumption about external dependencies}}
@@ -141,37 +162,45 @@ Before beginning, understand what inputs are available (brainstorming results, m
[[LLM: Identify unknowns and potential challenges proactively]]
### Key Risks
- **Risk 1:** {{Description and potential impact}}
- **Risk 2:** {{Description and potential impact}}
- **Risk 3:** {{Description and potential impact}}
### Open Questions
- {{Question needing research or decision}}
- {{Question about technical approach}}
- {{Question about market or users}}
### Areas Needing Further Research
- {{Topic requiring deeper investigation}}
- {{Validation needed before proceeding}}
## Appendices
### A. Research Summary
{{If applicable, summarize key findings from:
- Market research
- Competitive analysis
- Competitive analysis
- User interviews
- Technical feasibility studies}}
### B. Stakeholder Input
{{Key feedback or requirements from stakeholders}}
### C. References
{{Links to relevant documents, research, or examples}}
## Next Steps
### Immediate Actions
1. {{First concrete next step}}
2. {{Second concrete next step}}
3. {{Third concrete next step}}
@@ -184,8 +213,8 @@ This Project Brief provides the full context for {{Project Name}}. Please start
[[LLM: After completing each major section (not subsections), offer advanced elicitation with these custom options for project briefs:
**Project Brief Elicitation Actions**
0. Expand section with more specific details
**Project Brief Elicitation Actions** 0. Expand section with more specific details
1. Validate against similar successful products
2. Stress test assumptions with edge cases
3. Explore alternative solution approaches