Skip to content

Commit 225e62b

Browse files
committed
docs: update README to reflect current repo structure
1 parent 66c2f30 commit 225e62b

1 file changed

Lines changed: 22 additions & 12 deletions

File tree

  • agents/Mathews-Tom__project-architect
Lines changed: 22 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# project-architect
22

3-
System architecture agent with phased requirements discovery producing architecture documents with tech stack justification, Mermaid diagrams, and data flow design. Guides projects from vague ideas to concrete, implementable technical blueprints.
3+
System architecture agent that conducts phased requirements discovery and produces comprehensive architecture documents with technology stack justification, Mermaid diagrams, data flow design, and implementation roadmaps. Gathers business context before proposing technical solutions.
44

55
## Run
66

@@ -10,23 +10,33 @@ npx @open-gitagent/gitagent run -r https://github.com/Mathews-Tom/project-archit
1010

1111
## What It Can Do
1212

13-
- Conduct phased requirements discovery through structured questioning
14-
- Produce architecture decision records (ADRs) with justifications
15-
- Generate Mermaid diagrams for system topology and data flows
16-
- Evaluate and recommend tech stacks based on project constraints
17-
- Design API contracts and service boundaries
18-
- Create deployment architecture and infrastructure blueprints
13+
- **Business Discovery** — extracts product understanding, success metrics, constraints, and compliance requirements through structured questioning
14+
- **Technical Requirements** — gathers core functionality, platform needs, performance targets, and security requirements
15+
- **Technology Selection** — evaluates 2-3 options per component with scoring against requirements and tradeoff rationale
16+
- **Architecture Document Production** — generates executive summary, component breakdown, data architecture, security design, API design, and infrastructure topology with Mermaid diagrams
17+
- **ADR Generation** — produces Architecture Decision Records for key decisions with context, alternatives, and consequences
18+
- **Self-Validation** — reviews the produced architecture for missing components, scalability bottlenecks, and security gaps
1919

2020
## Structure
2121

2222
```
2323
project-architect/
24-
agent.yaml # Agent configuration and tool definitions
25-
SOUL.md # Agent personality and behavioral guidelines
26-
icon.png # 256x256 agent icon
27-
banner.png # 1200x630 agent banner
24+
├── .gitignore
25+
├── LICENSE
26+
├── README.md
27+
├── RULES.md
28+
├── SOUL.md
29+
├── agent.yaml
30+
├── assets/
31+
│ ├── icon.png
32+
│ └── banner.png
33+
└── knowledge/
34+
├── architecture-patterns.md
35+
├── tech-stack-evaluation.md
36+
├── mermaid-diagram-guide.md
37+
└── adr-template.md
2838
```
2939

3040
## Built with
3141

32-
[gitagent](https://github.com/open-gitagent/gitagent) - the open agent registry and runner.
42+
Built for the [gitagent](https://gitagent.sh) ecosystem.

0 commit comments

Comments
 (0)