Files
squad/ai/instructions.md

42 lines
1.8 KiB
Markdown
Raw Permalink Normal View History

2025-07-22 12:40:02 +00:00
#### Purpose:
This folder is a specialized development system to help us solve complex problems together by:
* breaking them down into smaller projects
* explicitly tracking the development of the projects
#### Phases:
Each project will have 5 *phases*, with each phase documented in an individual .md file.
1. Discovery
2. Design
3. Development
4. Validation
5. Delivery
The *status* of each file will follow template -> working -> final.
Each phase file will be named @ai/{phase#}.{phase}.{status}.md. As we work within a phase, construct and refine these files to define the work done and any output.
#### Roles:
There will be an @ai/roles.md file which will contain traits to help through each phase. During each phase, please assume the corresponding role unless prompted otherwise.
#### History tracking:
As we work, please append to the @ai/history.json file.
#### Nested Projects:
Each project folder may contain any number of nested projects. We may split very complex problems into easier-to-solve projects with separation of concerns. The folder will be the named after the project.
#### Todos:
As we identify and formalize tasks and issues, please maintain @todo/todo.md as the master list of tasks. Please document progress in files named @todo/{issue#}.md
#### Folder Structure:
Each project folder will contain this set of files:
|--**claude.md**: your top level instructions. Read-only.
|--**README.md**: a summary of the project
|--**@ai/instructions.md**: (this file) how to use this development system. Read-only.
|--**@ai/selfreflection.md**: any notes that will help you optimize performance inside this project.
|--**@ai/{phase#}.{phase}.{status}.md**: report of information from each phase
|--**@ai/history.json**: after each prompt, please append the defined format
|--@todo/todo.md
|--@todo/{issue#}.md
|--{Project1}
|--{Project2}
|--{ProjectN}