53 lines
1.7 KiB
Markdown
53 lines
1.7 KiB
Markdown
# Scaffolding Templates
|
|
|
|
This directory contains templates for quickly standing up new domains in the databank.
|
|
|
|
## Structure
|
|
|
|
```
|
|
scaffolding/
|
|
├── domain-template/ # Template for new domains
|
|
│ ├── README.md # Domain overview and purpose
|
|
│ ├── context/ # Context information for this domain
|
|
│ │ └── overview.md # Overview of domain context
|
|
│ ├── operations/ # Operational information
|
|
│ │ └── procedures.md # Standard operating procedures
|
|
│ ├── personnel/ # Personnel and roles
|
|
│ │ └── roles.md # Role definitions and responsibilities
|
|
│ ├── tools/ # Tools and technology
|
|
│ │ └── stack.md # Technology stack and tools
|
|
│ └── artifacts/ # Domain-specific artifacts
|
|
│ └── samples/ # Sample artifacts for reference
|
|
└── README.md # This file
|
|
```
|
|
|
|
## Purpose
|
|
|
|
The scaffolding directory provides templates for quickly creating new domains when needed. To create a new domain:
|
|
|
|
1. Copy the `domain-template/` directory to a new domain name
|
|
2. Customize the README.md with domain-specific information
|
|
3. Fill in context, operations, personnel, and tools information
|
|
4. Add domain-specific artifacts as needed
|
|
|
|
## Usage
|
|
|
|
To create a new domain called "marketing":
|
|
|
|
```bash
|
|
cp -r domain-template/ ../marketing/
|
|
cd ../marketing/
|
|
# Edit README.md to describe marketing domain
|
|
# Customize other files as appropriate
|
|
```
|
|
|
|
## Templates
|
|
|
|
Each template provides a starting point for new domains with:
|
|
|
|
- Standard directory structure
|
|
- Placeholder content for customization
|
|
- Consistent formatting and organization
|
|
- Cross-domain linking patterns
|
|
|
|
--- |