菜单
Technical documentation patterns including READMEs, API docs, runbooks, and architecture decision records. Use when writing documentation, creating runbooks, or documenting system architecture.
| name | documentation |
| description | Technical documentation patterns including READMEs, API docs, runbooks, and architecture decision records. Use when writing documentation, creating runbooks, or documenting system architecture. |
# Project Name
One-line description of what this does.
## Quick Start
\`\`\`bash
npm install
npm start
\`\`\`
## Configuration
| Variable | Description | Default |
|----------|-------------|---------|
| PORT | Server port | 3000 |
## Usage
[Examples of common operations]
## Development
[How to set up dev environment, run tests]
## License
MIT
Use OpenAPI/Swagger. Minimum per endpoint:
# [Service Name] Runbook
## Overview
What this service does, who owns it.
## Architecture
[Diagram or description of components]
## Health Checks
- Endpoint: `GET /health`
- Expected: 200 OK
## Common Issues
### Issue: High latency
**Symptoms**: Response times > 500ms
**Diagnosis**: Check DB connections, cache hit rate
**Resolution**: Scale horizontally, clear cache
## Escalation
- L1: On-call engineer
- L2: Service owner
- L3: Platform team
# ADR-001: Use PostgreSQL for user data
## Status
Accepted
## Context
Need persistent storage for user accounts.
## Decision
Use PostgreSQL on RDS.
## Consequences
- Pro: ACID compliance, familiar tooling
- Con: Operational overhead vs DynamoDB
AWS CLI best practices including pagination control, output formatting, and efficient querying. Use when running AWS CLI commands, querying AWS resources, or automating AWS operations.
AWS CloudWatch dashboard observability patterns including dashboard hierarchy, widget selection, CDK implementation, metric math, alarms, and cross-account monitoring. Use when creating dashboards, setting up observability, or instrumenting workloads with CloudWatch.
Docker image building best practices including multi-stage builds, layer optimization, and security hardening. Use when creating Dockerfiles, optimizing image size, or debugging container builds.
Git operations, branching strategies, commit conventions, and repository management. Use when working with version control, creating branches, writing commits, or resolving merge conflicts.
Bash and Zsh scripting patterns with built-in logging and non-interactive execution. Use when writing automation scripts, CLI tools, or system administration tasks.