Knowledge Base
Curated operational knowledge built from real-world experience.
Under 'paradigms' you can read about fundamental concepts in the system design field. These explain the critical technologies that enable software systems.
From there, the other directories focus on practical topics in system design.
Conventions
- Use obsidian-style linking to link to related documents
Structure
| Directory | Purpose |
|---|---|
paradigms/ |
Fundamental Concepts in System Design |
coding-practices/ |
Standardized coding patterns and conventions |
config-management/ |
Infrastructure-as-code guides and patterns |
components/ |
Open source component operations (postgres, redis, etc) |
observability/ |
Logging patterns, metrics, the 4 golden signals |
security/ |
Host configs, supply chain, network isolation |
Usage
Reference these docs when:
- Setting up new infrastructure
- Onboarding to a client project
- Troubleshooting common issues
- Establishing patterns for a new codebase
Contributing
When adding new knowledge:
- Place in the appropriate subdirectory
- Use clear, descriptive filenames
- Include practical examples where possible
- Link to authoritative sources when relevant