Skip to content

Commit de921c8

Browse files
committed
docs: formalize Product Requirements Document workflow
- Add PRD workflow to systemPatterns.md as a standardized development process - Update .clinerules with instructions to follow the PRD workflow - Update activeContext.md and progress.md to reference the new workflow This formalizes the process we used for implementing the server readiness probe feature. Tool: gitpod/catfood.gitpod.cloud
1 parent f417382 commit de921c8

File tree

4 files changed

+30
-0
lines changed

4 files changed

+30
-0
lines changed

memory-bank/.clinerules

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,15 @@ This file captures important patterns, preferences, and project intelligence tha
2626

2727
## Development Workflow
2828

29+
- **Feature Development Process**:
30+
- Follow the Product Requirements Document (PRD) workflow documented in systemPatterns.md under "Development Workflows"
31+
- Create PRD documents in the `prd/` directory with naming convention `NNN-featurename.md`
32+
- Include standard sections: Overview, Background, Requirements, Implementation Details, Testing, Deployment Considerations, Future Improvements
33+
- Use Plan Mode for requirements gathering and planning
34+
- Use Act Mode for implementation and documentation updates
35+
- Always update memory bank with new knowledge gained during implementation
36+
- Reference the PRD in commit messages and documentation
37+
2938
- **Build Approaches**:
3039
- **In-tree builds** (primary for local development):
3140
- TypeScript components: Use `yarn` commands defined in package.json

memory-bank/activeContext.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,10 +10,13 @@ Key areas of focus include:
1010
2. **Component Documentation**: Creating detailed documentation for each component
1111
3. **Development Workflow**: Understanding how to effectively develop and test changes
1212
4. **Documentation**: Maintaining a comprehensive memory bank for future reference
13+
5. **Standardized Workflows**: Establishing and documenting standardized workflows for development activities
1314

1415
## Recent Changes
1516

1617
- Created the initial memory bank structure with core files
18+
- Established standardized workflows for development activities:
19+
- Product Requirements Document (PRD) workflow for feature development
1720
- Added a components subdirectory to the memory bank
1821
- Created detailed documentation for key components:
1922
- blobserve: Service that provides static assets from OCI images

memory-bank/progress.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -217,6 +217,10 @@ No specific blockers or dependencies have been identified yet. This section will
217217
- Documented server architecture patterns and dependency injection
218218
- Added information about Kubernetes deployment configuration
219219
- Documented feature flag implementation for readiness probe
220+
- Established standardized development workflows:
221+
- Created `workflows.md` to document standardized development processes
222+
- Documented the Product Requirements Document (PRD) workflow
223+
- Updated `activeContext.md` to reference the new workflows
220224

221225
## Next Evaluation Point
222226

memory-bank/systemPatterns.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -131,3 +131,17 @@ Workspaces are treated as immutable, with changes to configuration resulting in
131131
7. **Leeway Build System**: Custom build system for managing the complex dependencies between components.
132132

133133
8. **Kubernetes Deployment Configuration**: All code that defines Kubernetes objects for deployable components lives in `install/installer`. This centralized approach ensures consistent deployment patterns across all components.
134+
135+
## Development Workflows
136+
137+
### Product Requirements Document (PRD) Workflow
138+
Gitpod uses a structured PRD workflow for feature development to ensure proper planning, documentation, and implementation:
139+
140+
1. **Requirements Gathering** (Plan Mode): Understand the problem, explore existing components, gather information
141+
2. **PRD Creation** (Plan Mode): Create a detailed document in `prd/` with standardized sections
142+
3. **Implementation Planning** (Plan Mode): Identify files to modify and plan the approach
143+
4. **Implementation** (Act Mode): Create/modify necessary files following the plan
144+
5. **Documentation Update** (Act Mode): Update memory bank with new knowledge
145+
6. **Verification**: Ensure implementation meets requirements and documentation is complete
146+
147+
This workflow ensures thorough planning, clear documentation, and knowledge preservation for all feature development.

0 commit comments

Comments
 (0)