Skip to content

Sample Guidance on how to version control "context" within the repository #11

@agonzalez2014

Description

@agonzalez2014

As part of "context or requirement gathering", a particular solution or system may range in complexity. For more complex systems, I'd like to propose and ideate with the team on how this could be organized as part of the repository as part of a "context" directory. This would transition providing the "prompt" for the /specify, /plan and /tasks/ operations away from typing it out (or copying it) into the command, and instead to reference or attach the relevant markdown file(s)

I'll provide a sample of what I recently did for one a project I worked on. This allowed me to cherry pick what context was relevant for me to provide to the AI Agent when going through design exploration, design evaluation, producing an implementation plan, and then iterating on that plan.

context/
├── high-level-components.md
├── business/
│   ├── capabilities/
│   │   ├── business-objectives.md
│   │   └── core-business-functions.md
│   ├── constraints/
│   │   ├── budget.md
│   │   ├── organizational.md
│   │   └── timelines.md
│   └── stakeholders/
│       ├── personas.md
│       └── requirements.md
│
├── system/
│   ├── capabilities.md
│   ├── constraints/
│   │   ├── compliance-requirements.md
│   │   └── technical-constraints.md
│   ├── interfaces/
│   │   ├── external-systems.md
│   │   └── integration-points.md
│   └── quality-attributes/
│       ├── maintainability.md
│       ├── performance.md
│       ├── scalability.md
│       └── security.md
│
├── application/
│   ├── capabilities/
│   │   ├── functional-requirements.md
│   │   └── non-functional-requirements.md
│   └── constraints/
│       ├── constraints.md
│       └── service-limitations.md

Metadata

Metadata

Assignees

Labels

documentationImprovements or additions to documentation

Type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions