129 lines
4.4 KiB
Markdown
Executable File
129 lines
4.4 KiB
Markdown
Executable File
# Standards Documentation Index
|
|
|
|
> Navigation hub for documentation standards and patterns.
|
|
|
|
---
|
|
|
|
## Overview
|
|
|
|
This directory contains documentation standards that ensure consistency, maintainability, and efficiency across all project documentation.
|
|
|
|
---
|
|
|
|
## Quick Reference Table
|
|
|
|
| Document | Purpose | Key Rules |
|
|
|----------|---------|-----------|
|
|
| [TEST_PRODUCTION_SEPARATION.md](./TEST_PRODUCTION_SEPARATION.md) | Test/production isolation | MANDATORY separation requirements |
|
|
| [MODULAR_DOCUMENTATION.md](./MODULAR_DOCUMENTATION.md) | 500-line max rule | No doc over 500 lines |
|
|
| [LOGGING_PATTERNS.md](./LOGGING_PATTERNS.md) | Array-based logging | Standard log format |
|
|
| [LOGGING_INTEGRATION.md](./LOGGING_INTEGRATION.md) | External logging hooks | Hook interface spec |
|
|
| [API_SPECIFICATIONS.md](./API_SPECIFICATIONS.md) | OpenAPI + OpenSpec | When to use each |
|
|
| [GAME_BUILD_VALIDATION.md](./GAME_BUILD_VALIDATION.md) | Game engine validation | Godot/Unity/Unreal headless checks |
|
|
| [CROSS_CUTTING_2026.md](./CROSS_CUTTING_2026.md) | 2026 universal standards | SBOM, SLSA, AI code gen, OWASP |
|
|
|
|
---
|
|
|
|
## Document Summaries
|
|
|
|
### TEST_PRODUCTION_SEPARATION.md
|
|
Establishes mandatory standards for separating test and production environments. All testing code, data, services, and infrastructure must be completely isolated from production.
|
|
|
|
**Key sections:**
|
|
- The Three Laws of Test/Production Separation
|
|
- Environment separation requirements (databases, services, users)
|
|
- Code creation sequence (production first, then test)
|
|
- Test code labeling requirements
|
|
- Uncertainty handling protocol
|
|
- Examples, patterns, and anti-patterns
|
|
- Blocking violations checklist
|
|
|
|
### MODULAR_DOCUMENTATION.md
|
|
Defines the 500-line maximum rule for all documentation files and provides strategies for splitting large documents.
|
|
|
|
**Key sections:**
|
|
- The 500-Line Rule (why and how)
|
|
- Document structure standards
|
|
- Breaking up large documents
|
|
- Directory organization
|
|
- Compliance checklist
|
|
|
|
### LOGGING_PATTERNS.md
|
|
Establishes array-based structured logging patterns for agent operations.
|
|
|
|
**Key sections:**
|
|
- Array-based log entry structure
|
|
- Log levels (DEBUG, INFO, WARN, ERROR)
|
|
- Standard log categories
|
|
- Log array management
|
|
- Output formats
|
|
|
|
### LOGGING_INTEGRATION.md
|
|
Defines hooks and interfaces for integrating with external logging systems.
|
|
|
|
**Key sections:**
|
|
- Standard hook interface
|
|
- Webhook integration patterns
|
|
- File-based integration
|
|
- Queue-based integration
|
|
- Error handling
|
|
|
|
### API_SPECIFICATIONS.md
|
|
Guidance on choosing between OpenAPI and OpenSpec for API documentation.
|
|
|
|
**Key sections:**
|
|
- OpenAPI overview and use cases
|
|
- OpenSpec overview and use cases
|
|
- When to use each format
|
|
- Hybrid approach guidance
|
|
- Template files
|
|
|
|
### GAME_BUILD_VALIDATION.md
|
|
Validates game engine projects (Godot, Unity, Unreal) as part of the guardrails framework. Runs headless build checks, script validation, and test execution.
|
|
|
|
**Key sections:**
|
|
- MCP tool: guardrail_validate_game_build
|
|
- Validation pipeline (detect, config, headless, scenes, scripts, tests)
|
|
- Supported engines (Godot full, Unity/Unreal planned)
|
|
- Test script format (PASS/FAIL output)
|
|
- Integration with pre-work check
|
|
|
|
### CROSS_CUTTING_2026.md
|
|
Cross-cutting security and quality standards for ALL language profiles, reflecting 2026 best practices.
|
|
|
|
**Key sections:**
|
|
- Supply Chain Security (SBOM/SLSA, dependency verification)
|
|
- Secret Scanning (gitleaks, rotation guard)
|
|
- AI Code Generation Awareness (hallucinated deps, mandatory review)
|
|
- License Compliance (compatibility checks)
|
|
- Container Security (CVE scanning, multi-stage builds)
|
|
- OWASP Top 10 (2025/2026 checks)
|
|
- Mobile/Game (performance budgets, privacy, app store)
|
|
|
|
---
|
|
|
|
## Integration with Guardrails
|
|
|
|
These standards support the [AGENT_GUARDRAILS.md](../AGENT_GUARDRAILS.md) requirements for:
|
|
|
|
- **Test/production separation** → TEST_PRODUCTION_SEPARATION.md
|
|
- **Audit requirements** → LOGGING_PATTERNS.md
|
|
- **External integration** → LOGGING_INTEGRATION.md
|
|
- **Documentation quality** → MODULAR_DOCUMENTATION.md
|
|
- **API documentation** → API_SPECIFICATIONS.md
|
|
- **Game build safety** → GAME_BUILD_VALIDATION.md
|
|
- **2026 universal standards** → CROSS_CUTTING_2026.md
|
|
|
|
---
|
|
|
|
## Related Documents
|
|
|
|
- [AGENT_GUARDRAILS.md](../AGENT_GUARDRAILS.md) - Mandatory safety protocols
|
|
- [../workflows/INDEX.md](../workflows/INDEX.md) - Operational workflows
|
|
- [../sprints/INDEX.md](../sprints/INDEX.md) - Sprint task framework
|
|
|
|
---
|
|
|
|
**Last Updated:** 2026-04-16
|
|
**Document Count:** 7
|