* feat(context): Add project intelligence system - Add project-intelligence.md standard (what & why) - Add project-intelligence-management.md guide (how to manage) - Add project-intelligence/ folder with 6 context files: - navigation.md (quick overview & routes) - business-domain.md (business context, users, value) - technical-domain.md (stack, architecture, decisions) - business-tech-bridge.md (business → technical mapping) - decisions-log.md (decision history with context) - living-notes.md (active issues, debt, questions) - Update standards navigation with new entries - Register all new contexts in registry.json This enables projects to document and maintain business + technical context for quick onboarding and lasting project understanding. * fix(registry): Add project-intelligence to profiles - Add context:project-intelligence/* to developer, business, full, and advanced profiles - Ensures project intelligence contexts are included when these profiles are selected This complements commit c731328 which added the context entries. * docs(core): refine project intelligence system and deprecate legacy context
3.4 KiB
3.4 KiB
Technical Domain
Document the technical foundation, architecture, and key decisions.
Quick Reference
- Purpose: Understand how the project works technically
- Update When: New features, refactoring, tech stack changes
- Audience: Developers, DevOps, technical stakeholders
Primary Stack
| Layer | Technology | Version | Rationale |
|---|---|---|---|
| Language | [e.g., TypeScript] | [Version] | [Why this language] |
| Framework | [e.g., Node.js] | [Version] | [Why this framework] |
| Database | [e.g., PostgreSQL] | [Version] | [Why this database] |
| Infrastructure | [e.g., AWS, Vercel] | [N/A] | [Why this infra] |
| Key Libraries | [List important ones] | [Versions] | [Why each matters] |
Architecture Pattern
Type: [Monolith | Microservices | Serverless | Agent-based | Hybrid]
Pattern: [Brief description]
Diagram: [Link to architecture diagram if exists]
Why This Architecture?
[Explain the business and technical reasons for this architecture choice. What problem does this architecture solve? What were alternatives considered?]
Project Structure
[Project Root]
├── src/ # Source code
├── tests/ # Test files
├── docs/ # Documentation
├── scripts/ # Build/deploy scripts
└── [Other key directories]
Key Directories:
src/- Contains all application logic organized by [module/feature/domain]tests/- [How tests are organized]docs/- [What documentation lives here]
Key Technical Decisions
| Decision | Rationale | Impact |
|---|---|---|
| [Decision 1] | [Why this choice] | [What it enables] |
| [Decision 2] | [Why this choice] | [What it enables] |
See decisions-log.md for full decision history with alternatives.
Integration Points
| System | Purpose | Protocol | Direction |
|---|---|---|---|
| [API 1] | [What it does] | [REST/GraphQL/gRPC] | [Inbound/Outbound] |
| [Database] | [What it stores] | [PostgreSQL/Mongo/etc] | [Internal] |
| [Service] | [What it provides] | [HTTP/gRPC] | [Outbound] |
Technical Constraints
| Constraint | Origin | Impact |
|---|---|---|
| [Legacy systems] | [Business/Tech] | [What limitation it creates] |
| [Compliance] | [Regulation] | [What must be followed] |
| [Performance] | [SLAs] | [What must be met] |
Development Environment
Setup: [Quick setup command or link]
Requirements: [What developers need installed]
Local Dev: [How to run locally]
Testing: [How to run tests]
Deployment
Environment: [Production/Staging/Development]
Platform: [Where it deploys]
CI/CD: [Pipeline used]
Monitoring: [Tools for observability]
Onboarding Checklist
- Know the primary tech stack
- Understand the architecture pattern and why it was chosen
- Know the key project directories and their purpose
- Understand major technical decisions and rationale
- Know integration points and dependencies
- Be able to set up local development environment
- Know how to run tests and deploy
Related Files
business-domain.md- Why this technical foundation existsbusiness-tech-bridge.md- How business needs map to technical solutionsdecisions-log.md- Full decision history with context