docs re-org, audit fixes, build fixes
This commit is contained in:
98
docs/modules/_template/architecture.md
Normal file
98
docs/modules/_template/architecture.md
Normal file
@@ -0,0 +1,98 @@
|
||||
# <Module Name> Architecture
|
||||
|
||||
> Technical architecture specification for <Module Name>.
|
||||
|
||||
## Overview
|
||||
|
||||
High-level description of the module's architecture and how it fits into the StellaOps platform.
|
||||
|
||||
## Design Principles
|
||||
|
||||
1. **Principle 1** - Description of how this module follows or implements this principle
|
||||
2. **Principle 2** - Description
|
||||
3. **Principle 3** - Description
|
||||
|
||||
## Components
|
||||
|
||||
```
|
||||
<module-name>/
|
||||
├── __Libraries/
|
||||
│ ├── StellaOps.<ModuleName>.Core/ # Core business logic
|
||||
│ ├── StellaOps.<ModuleName>.Storage/ # Data persistence (if applicable)
|
||||
│ └── StellaOps.<ModuleName>.Client/ # Client SDK (if applicable)
|
||||
├── StellaOps.<ModuleName>.WebService/ # HTTP API (if applicable)
|
||||
├── StellaOps.<ModuleName>.Worker/ # Background processing (if applicable)
|
||||
└── __Tests/
|
||||
└── StellaOps.<ModuleName>.*.Tests/ # Test projects
|
||||
```
|
||||
|
||||
## Data Flow
|
||||
|
||||
```
|
||||
[Input Source] → [Processing] → [Output/Storage]
|
||||
```
|
||||
|
||||
Describe the primary data flow through this module.
|
||||
|
||||
## Key Abstractions
|
||||
|
||||
### Interface 1
|
||||
```csharp
|
||||
public interface I<Something>
|
||||
{
|
||||
Task<Result> DoSomethingAsync(Input input, CancellationToken ct);
|
||||
}
|
||||
```
|
||||
|
||||
Purpose and usage of this interface.
|
||||
|
||||
### Interface 2
|
||||
```csharp
|
||||
public interface I<SomethingElse>
|
||||
{
|
||||
// ...
|
||||
}
|
||||
```
|
||||
|
||||
Purpose and usage.
|
||||
|
||||
## Database Schema (if applicable)
|
||||
|
||||
| Table | Purpose |
|
||||
|-------|---------|
|
||||
| `schema.table_1` | Description |
|
||||
| `schema.table_2` | Description |
|
||||
|
||||
## Invariants
|
||||
|
||||
Non-negotiable design constraints that must always be maintained:
|
||||
|
||||
1. **Invariant 1** - Description and why it matters
|
||||
2. **Invariant 2** - Description
|
||||
3. **Invariant 3** - Description
|
||||
|
||||
## Error Handling
|
||||
|
||||
How errors are handled, propagated, and logged in this module.
|
||||
|
||||
## Observability
|
||||
|
||||
- **Metrics**: Key metrics exposed by this module
|
||||
- **Traces**: OpenTelemetry trace spans
|
||||
- **Logs**: Structured logging patterns
|
||||
|
||||
## Security Considerations
|
||||
|
||||
Security-relevant aspects of this module's design.
|
||||
|
||||
## Performance Characteristics
|
||||
|
||||
- Expected throughput
|
||||
- Latency budgets
|
||||
- Resource constraints
|
||||
|
||||
## References
|
||||
|
||||
- [Module README](./README.md)
|
||||
- [API Documentation](./api/)
|
||||
- [Operations Guide](./operations/)
|
||||
Reference in New Issue
Block a user