ai-playbook 1.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +146 -0
- package/agents/README.md +168 -0
- package/agents/SKILL.md +633 -0
- package/agents/architect/AGENT.md +44 -0
- package/agents/architect/README.md +5 -0
- package/agents/coder/AGENT.md +43 -0
- package/agents/coder/README.md +5 -0
- package/agents/debugger/AGENT.md +42 -0
- package/agents/debugger/README.md +6 -0
- package/agents/devops/AGENT.md +43 -0
- package/agents/devops/README.md +5 -0
- package/agents/documentation/AGENT.md +45 -0
- package/agents/documentation/README.md +5 -0
- package/agents/examples.md +550 -0
- package/agents/performance/AGENT.md +45 -0
- package/agents/performance/README.md +6 -0
- package/agents/planner/AGENT.md +44 -0
- package/agents/planner/README.md +6 -0
- package/agents/product-owner/AGENT.md +46 -0
- package/agents/product-owner/README.md +6 -0
- package/agents/refactorer/AGENT.md +44 -0
- package/agents/refactorer/README.md +6 -0
- package/agents/release-manager/AGENT.md +45 -0
- package/agents/release-manager/README.md +6 -0
- package/agents/researcher/AGENT.md +44 -0
- package/agents/researcher/README.md +6 -0
- package/agents/reviewer/AGENT.md +43 -0
- package/agents/reviewer/README.md +6 -0
- package/agents/security/AGENT.md +46 -0
- package/agents/security/README.md +6 -0
- package/agents/support/AGENT.md +45 -0
- package/agents/support/README.md +6 -0
- package/agents/tester/AGENT.md +46 -0
- package/agents/tester/README.md +5 -0
- package/bin/cli.js +186 -0
- package/commands/README.md +266 -0
- package/commands/build.md +135 -0
- package/commands/clean.md +126 -0
- package/commands/deploy-prod.md +171 -0
- package/commands/deploy-staging.md +147 -0
- package/commands/deps.md +169 -0
- package/commands/dev.md +132 -0
- package/commands/format.md +142 -0
- package/commands/lint.md +125 -0
- package/commands/migrate.md +159 -0
- package/commands/release.md +183 -0
- package/commands/rollback.md +152 -0
- package/commands/seed.md +178 -0
- package/commands/setup.md +109 -0
- package/commands/test.md +134 -0
- package/commands/validate.md +147 -0
- package/context/README.md +7 -0
- package/context/aem.md +47 -0
- package/context/architecture.md +51 -0
- package/context/bullminder.md +57 -0
- package/context/coding-style.md +42 -0
- package/context/communication.md +53 -0
- package/context/company.md +46 -0
- package/context/engineering.md +63 -0
- package/context/project-template.md +71 -0
- package/context/trading.md +52 -0
- package/hooks/README.md +326 -0
- package/hooks/code-review/README.md +6 -0
- package/hooks/code-review/check-coverage.md +101 -0
- package/hooks/custom/README.md +6 -0
- package/hooks/custom/project-specific-hooks.md +273 -0
- package/hooks/deployment/README.md +6 -0
- package/hooks/deployment/health-check.md +102 -0
- package/hooks/deployment/pre-deploy-check.md +84 -0
- package/hooks/documentation/README.md +6 -0
- package/hooks/documentation/update-changelog.md +146 -0
- package/hooks/post-task/README.md +5 -0
- package/hooks/post-task/run-tests.md +61 -0
- package/hooks/pre-commit/README.md +6 -0
- package/hooks/pre-commit/format.md +63 -0
- package/hooks/pre-commit/lint.md +62 -0
- package/hooks/pre-commit/type-check.md +78 -0
- package/hooks/pre-task/README.md +6 -0
- package/hooks/pre-task/check-branch.md +48 -0
- package/hooks/pre-task/validate-environment.md +48 -0
- package/hooks/security-check/README.md +6 -0
- package/hooks/security-check/dependency-audit.md +85 -0
- package/hooks/security-check/secrets-scan.md +77 -0
- package/hooks/test-before-finish/README.md +6 -0
- package/hooks/test-before-finish/run-all-tests.md +128 -0
- package/index.js +69 -0
- package/knowledge/README.md +33 -0
- package/knowledge/ai-agents.md +74 -0
- package/knowledge/decision-making.md +73 -0
- package/knowledge/documentation.md +67 -0
- package/knowledge/engineering-principles.md +65 -0
- package/knowledge/product-discovery.md +68 -0
- package/knowledge/security-privacy.md +54 -0
- package/knowledge/testing-quality.md +63 -0
- package/package.json +63 -0
- package/patterns/README.md +7 -0
- package/prompts/README.md +208 -0
- package/prompts/architect/README.md +96 -0
- package/prompts/architect/design-system.md +140 -0
- package/prompts/debugger/README.md +96 -0
- package/prompts/debugger/diagnose-issue.md +141 -0
- package/prompts/developer/README.md +129 -0
- package/prompts/developer/fix-bug.md +136 -0
- package/prompts/developer/implement-feature.md +133 -0
- package/prompts/product-owner/README.md +116 -0
- package/prompts/product-owner/define-feature.md +145 -0
- package/prompts/reviewer/README.md +91 -0
- package/prompts/reviewer/code-review.md +129 -0
- package/prompts/support/README.md +154 -0
- package/prompts/support/resolve-issue.md +124 -0
- package/roles/README.md +6 -0
- package/roles/design-architect/README.md +98 -0
- package/roles/design-architect/accessibility/README.md +33 -0
- package/roles/design-architect/accessibility/checklists.md +29 -0
- package/roles/design-architect/accessibility/examples.md +35 -0
- package/roles/design-architect/checklists.md +76 -0
- package/roles/design-architect/component-library/README.md +35 -0
- package/roles/design-architect/component-library/checklists.md +29 -0
- package/roles/design-architect/component-library/examples.md +35 -0
- package/roles/design-architect/design-system/README.md +35 -0
- package/roles/design-architect/design-system/checklists.md +27 -0
- package/roles/design-architect/design-system/examples.md +41 -0
- package/roles/design-architect/examples/README.md +31 -0
- package/roles/design-architect/examples/checklists.md +26 -0
- package/roles/design-architect/examples/examples.md +46 -0
- package/roles/design-architect/examples.md +90 -0
- package/roles/design-architect/figma/README.md +33 -0
- package/roles/design-architect/figma/checklists.md +27 -0
- package/roles/design-architect/figma/examples.md +38 -0
- package/roles/design-architect/responsibilities.md +73 -0
- package/roles/design-architect/responsive/README.md +34 -0
- package/roles/design-architect/responsive/checklists.md +26 -0
- package/roles/design-architect/responsive/examples.md +39 -0
- package/roles/design-architect/role.md +129 -0
- package/roles/design-architect/skill-map.md +42 -0
- package/roles/design-architect/triggers.md +110 -0
- package/roles/design-architect/ui/README.md +36 -0
- package/roles/design-architect/ui/checklists.md +29 -0
- package/roles/design-architect/ui/examples.md +28 -0
- package/roles/design-architect/usability/README.md +34 -0
- package/roles/design-architect/usability/checklists.md +28 -0
- package/roles/design-architect/usability/examples.md +31 -0
- package/roles/design-architect/ux/README.md +36 -0
- package/roles/design-architect/ux/checklists.md +28 -0
- package/roles/design-architect/ux/examples.md +37 -0
- package/roles/design-architect/wireframes/README.md +34 -0
- package/roles/design-architect/wireframes/checklists.md +25 -0
- package/roles/design-architect/wireframes/examples.md +32 -0
- package/roles/design-architect/workflow.md +80 -0
- package/roles/devops/README.md +101 -0
- package/roles/devops/ansible/README.md +6 -0
- package/roles/devops/checklists.md +413 -0
- package/roles/devops/ci-cd/README.md +169 -0
- package/roles/devops/ci-cd/checklists.md +289 -0
- package/roles/devops/ci-cd/examples.md +429 -0
- package/roles/devops/cloud-platforms/README.md +109 -0
- package/roles/devops/cost-optimization/README.md +131 -0
- package/roles/devops/disaster-recovery/README.md +118 -0
- package/roles/devops/docker/README.md +6 -0
- package/roles/devops/examples/README.md +6 -0
- package/roles/devops/examples.md +775 -0
- package/roles/devops/github-actions/README.md +6 -0
- package/roles/devops/helm/README.md +6 -0
- package/roles/devops/infrastructure-as-code/README.md +160 -0
- package/roles/devops/infrastructure-as-code/checklists.md +124 -0
- package/roles/devops/jenkins/README.md +6 -0
- package/roles/devops/kubernetes/README.md +150 -0
- package/roles/devops/kubernetes/checklists.md +192 -0
- package/roles/devops/kubernetes/examples.md +189 -0
- package/roles/devops/monitoring/README.md +93 -0
- package/roles/devops/networking/README.md +83 -0
- package/roles/devops/performance/README.md +104 -0
- package/roles/devops/responsibilities.md +95 -0
- package/roles/devops/role.md +130 -0
- package/roles/devops/security/README.md +126 -0
- package/roles/devops/skill-map.md +162 -0
- package/roles/devops/terraform/README.md +6 -0
- package/roles/devops/triggers.md +241 -0
- package/roles/devops/workflow.md +197 -0
- package/roles/qa/README.md +16 -0
- package/roles/qa/api-testing/README.md +6 -0
- package/roles/qa/automation/README.md +6 -0
- package/roles/qa/checklists.md +24 -0
- package/roles/qa/examples/README.md +6 -0
- package/roles/qa/examples.md +27 -0
- package/roles/qa/performance/README.md +6 -0
- package/roles/qa/playwright/README.md +6 -0
- package/roles/qa/responsibilities.md +16 -0
- package/roles/qa/role.md +47 -0
- package/roles/qa/selenium/README.md +6 -0
- package/roles/qa/skill-map.md +14 -0
- package/roles/qa/triggers.md +10 -0
- package/roles/qa/workflow.md +9 -0
- package/roles/software-architect/README.md +16 -0
- package/roles/software-architect/agents/README.md +6 -0
- package/roles/software-architect/ai-architecture/README.md +6 -0
- package/roles/software-architect/aws/README.md +6 -0
- package/roles/software-architect/azure/README.md +6 -0
- package/roles/software-architect/caching/README.md +6 -0
- package/roles/software-architect/checklists.md +25 -0
- package/roles/software-architect/cloud/README.md +6 -0
- package/roles/software-architect/database-design/README.md +6 -0
- package/roles/software-architect/diagrams/README.md +6 -0
- package/roles/software-architect/distributed-systems/README.md +7 -0
- package/roles/software-architect/docker/README.md +6 -0
- package/roles/software-architect/event-driven/README.md +7 -0
- package/roles/software-architect/examples/README.md +6 -0
- package/roles/software-architect/examples.md +22 -0
- package/roles/software-architect/gcp/README.md +6 -0
- package/roles/software-architect/kubernetes/README.md +6 -0
- package/roles/software-architect/messaging/README.md +6 -0
- package/roles/software-architect/rag/README.md +7 -0
- package/roles/software-architect/responsibilities.md +17 -0
- package/roles/software-architect/role.md +46 -0
- package/roles/software-architect/scalability/README.md +6 -0
- package/roles/software-architect/security/README.md +6 -0
- package/roles/software-architect/skill-map.md +15 -0
- package/roles/software-architect/system-design/README.md +6 -0
- package/roles/software-architect/triggers.md +10 -0
- package/roles/software-architect/vector-db/README.md +6 -0
- package/roles/software-architect/workflow.md +9 -0
- package/roles/software-developer/README.md +116 -0
- package/roles/software-developer/api/README.md +365 -0
- package/roles/software-developer/api/checklist.md +131 -0
- package/roles/software-developer/api/examples.md +459 -0
- package/roles/software-developer/authentication/README.md +26 -0
- package/roles/software-developer/authentication/checklists.md +22 -0
- package/roles/software-developer/authentication/examples.md +32 -0
- package/roles/software-developer/authorization/README.md +26 -0
- package/roles/software-developer/authorization/checklists.md +21 -0
- package/roles/software-developer/authorization/examples.md +27 -0
- package/roles/software-developer/backend/README.md +26 -0
- package/roles/software-developer/backend/checklists.md +21 -0
- package/roles/software-developer/backend/examples.md +21 -0
- package/roles/software-developer/cache/README.md +25 -0
- package/roles/software-developer/cache/checklists.md +21 -0
- package/roles/software-developer/cache/examples.md +22 -0
- package/roles/software-developer/checklists.md +122 -0
- package/roles/software-developer/code-review/README.md +23 -0
- package/roles/software-developer/code-review/checklists.md +22 -0
- package/roles/software-developer/code-review/examples.md +20 -0
- package/roles/software-developer/database/README.md +27 -0
- package/roles/software-developer/database/checklists.md +21 -0
- package/roles/software-developer/database/examples.md +27 -0
- package/roles/software-developer/debugging/README.md +24 -0
- package/roles/software-developer/debugging/checklists.md +20 -0
- package/roles/software-developer/debugging/examples.md +28 -0
- package/roles/software-developer/examples/README.md +22 -0
- package/roles/software-developer/examples/checklists.md +8 -0
- package/roles/software-developer/examples/examples.md +25 -0
- package/roles/software-developer/examples.md +378 -0
- package/roles/software-developer/frontend/README.md +76 -0
- package/roles/software-developer/frontend/accessibility/README.md +136 -0
- package/roles/software-developer/frontend/accessibility/best-practices.md +368 -0
- package/roles/software-developer/frontend/code-quality/README.md +136 -0
- package/roles/software-developer/frontend/code-quality/best-practices.md +309 -0
- package/roles/software-developer/frontend/components/README.md +65 -0
- package/roles/software-developer/frontend/components/best-practices.md +273 -0
- package/roles/software-developer/frontend/debugging/README.md +149 -0
- package/roles/software-developer/frontend/debugging/best-practices.md +329 -0
- package/roles/software-developer/frontend/examples/README.md +19 -0
- package/roles/software-developer/frontend/examples/checklists.md +8 -0
- package/roles/software-developer/frontend/examples/examples.md +17 -0
- package/roles/software-developer/frontend/logging-observability/README.md +196 -0
- package/roles/software-developer/frontend/logging-observability/best-practices.md +430 -0
- package/roles/software-developer/frontend/performance/README.md +99 -0
- package/roles/software-developer/frontend/performance/best-practices.md +350 -0
- package/roles/software-developer/frontend/state-management/README.md +85 -0
- package/roles/software-developer/frontend/state-management/best-practices.md +344 -0
- package/roles/software-developer/frontend/testing/README.md +114 -0
- package/roles/software-developer/frontend/testing/best-practices.md +272 -0
- package/roles/software-developer/fullstack/README.md +25 -0
- package/roles/software-developer/fullstack/checklists.md +19 -0
- package/roles/software-developer/fullstack/examples.md +14 -0
- package/roles/software-developer/graphql/README.md +24 -0
- package/roles/software-developer/graphql/checklists.md +20 -0
- package/roles/software-developer/graphql/examples.md +24 -0
- package/roles/software-developer/integration-tests/README.md +25 -0
- package/roles/software-developer/integration-tests/checklists.md +20 -0
- package/roles/software-developer/integration-tests/examples.md +18 -0
- package/roles/software-developer/java/README.md +24 -0
- package/roles/software-developer/java/checklists.md +16 -0
- package/roles/software-developer/java/examples.md +22 -0
- package/roles/software-developer/javascript/README.md +24 -0
- package/roles/software-developer/javascript/checklists.md +15 -0
- package/roles/software-developer/javascript/examples.md +18 -0
- package/roles/software-developer/logging/README.md +105 -0
- package/roles/software-developer/logging/checklists.md +48 -0
- package/roles/software-developer/logging/examples.md +135 -0
- package/roles/software-developer/messaging/README.md +24 -0
- package/roles/software-developer/messaging/checklists.md +21 -0
- package/roles/software-developer/messaging/examples.md +26 -0
- package/roles/software-developer/microservices/README.md +25 -0
- package/roles/software-developer/microservices/checklists.md +21 -0
- package/roles/software-developer/microservices/examples.md +21 -0
- package/roles/software-developer/node/README.md +25 -0
- package/roles/software-developer/node/checklists.md +15 -0
- package/roles/software-developer/node/examples.md +15 -0
- package/roles/software-developer/nosql/README.md +24 -0
- package/roles/software-developer/nosql/checklists.md +21 -0
- package/roles/software-developer/nosql/examples.md +20 -0
- package/roles/software-developer/observability/README.md +25 -0
- package/roles/software-developer/observability/checklists.md +21 -0
- package/roles/software-developer/observability/examples.md +22 -0
- package/roles/software-developer/performance/README.md +26 -0
- package/roles/software-developer/performance/checklists.md +20 -0
- package/roles/software-developer/performance/examples.md +20 -0
- package/roles/software-developer/python/README.md +25 -0
- package/roles/software-developer/python/checklists.md +15 -0
- package/roles/software-developer/python/examples.md +17 -0
- package/roles/software-developer/react/README.md +24 -0
- package/roles/software-developer/react/checklists.md +15 -0
- package/roles/software-developer/react/examples.md +22 -0
- package/roles/software-developer/refactoring/README.md +23 -0
- package/roles/software-developer/refactoring/checklists.md +21 -0
- package/roles/software-developer/refactoring/examples.md +11 -0
- package/roles/software-developer/responsibilities.md +58 -0
- package/roles/software-developer/role.md +127 -0
- package/roles/software-developer/skill-map.md +88 -0
- package/roles/software-developer/springboot/README.md +25 -0
- package/roles/software-developer/springboot/checklists.md +15 -0
- package/roles/software-developer/springboot/examples.md +21 -0
- package/roles/software-developer/sql/README.md +24 -0
- package/roles/software-developer/sql/checklists.md +22 -0
- package/roles/software-developer/sql/examples.md +20 -0
- package/roles/software-developer/testing/README.md +25 -0
- package/roles/software-developer/testing/checklists.md +21 -0
- package/roles/software-developer/testing/examples.md +19 -0
- package/roles/software-developer/triggers.md +550 -0
- package/roles/software-developer/typescript/README.md +25 -0
- package/roles/software-developer/typescript/checklists.md +15 -0
- package/roles/software-developer/typescript/examples.md +18 -0
- package/roles/software-developer/unit-tests/README.md +24 -0
- package/roles/software-developer/unit-tests/checklists.md +19 -0
- package/roles/software-developer/unit-tests/examples.md +22 -0
- package/roles/software-developer/workflow.md +196 -0
- package/roles/sre/README.md +16 -0
- package/roles/sre/alerts/README.md +6 -0
- package/roles/sre/availability/README.md +6 -0
- package/roles/sre/chaos/README.md +6 -0
- package/roles/sre/checklists.md +24 -0
- package/roles/sre/examples/README.md +6 -0
- package/roles/sre/examples.md +19 -0
- package/roles/sre/observability/README.md +6 -0
- package/roles/sre/reliability/README.md +6 -0
- package/roles/sre/responsibilities.md +16 -0
- package/roles/sre/role.md +46 -0
- package/roles/sre/skill-map.md +14 -0
- package/roles/sre/slos/README.md +6 -0
- package/roles/sre/triggers.md +10 -0
- package/roles/sre/workflow.md +9 -0
- package/roles/support-engineer/README.md +16 -0
- package/roles/support-engineer/checklists.md +24 -0
- package/roles/support-engineer/datadog/README.md +6 -0
- package/roles/support-engineer/examples/README.md +6 -0
- package/roles/support-engineer/examples.md +17 -0
- package/roles/support-engineer/incident-response/README.md +6 -0
- package/roles/support-engineer/kubernetes/README.md +6 -0
- package/roles/support-engineer/linux/README.md +6 -0
- package/roles/support-engineer/logs/README.md +6 -0
- package/roles/support-engineer/monitoring/README.md +6 -0
- package/roles/support-engineer/networking/README.md +6 -0
- package/roles/support-engineer/newrelic/README.md +6 -0
- package/roles/support-engineer/postmortem/README.md +6 -0
- package/roles/support-engineer/production/README.md +6 -0
- package/roles/support-engineer/responsibilities.md +16 -0
- package/roles/support-engineer/role.md +47 -0
- package/roles/support-engineer/root-cause-analysis/README.md +6 -0
- package/roles/support-engineer/runbooks/README.md +6 -0
- package/roles/support-engineer/skill-map.md +14 -0
- package/roles/support-engineer/splunk/README.md +6 -0
- package/roles/support-engineer/triggers.md +10 -0
- package/roles/support-engineer/troubleshooting/README.md +6 -0
- package/roles/support-engineer/workflow.md +9 -0
- package/setup.sh +204 -0
- package/skills/.claude/README.md +7 -0
- package/skills/README.md +21 -0
- package/skills/ai-agents/README.md +207 -0
- package/skills/ai-agents/examples.md +335 -0
- package/skills/ai-agents/skill.md +392 -0
- package/skills/architecture/README.md +198 -0
- package/skills/architecture/examples.md +316 -0
- package/skills/architecture/skill.md +189 -0
- package/skills/design-architecture/README.md +107 -0
- package/skills/design-architecture/examples.md +84 -0
- package/skills/design-architecture/skill.md +192 -0
- package/skills/devops/README.md +177 -0
- package/skills/devops/examples.md +376 -0
- package/skills/devops/skill.md +210 -0
- package/skills/documentation/README.md +182 -0
- package/skills/documentation/examples.md +364 -0
- package/skills/documentation/skill.md +200 -0
- package/skills/performance/README.md +177 -0
- package/skills/performance/examples.md +376 -0
- package/skills/performance/skill.md +199 -0
- package/skills/qa/README.md +106 -0
- package/skills/qa/examples.md +84 -0
- package/skills/qa/skill.md +384 -0
- package/skills/security/README.md +108 -0
- package/skills/security/examples.md +85 -0
- package/skills/security/skill.md +223 -0
- package/skills/software-development/README.md +239 -0
- package/skills/software-development/assessment.md +0 -0
- package/skills/software-development/checklists.md +0 -0
- package/skills/software-development/examples.md +375 -0
- package/skills/software-development/prompts.md +0 -0
- package/skills/software-development/skill.md +390 -0
- package/skills/software-development/templates/README.md +7 -0
- package/skills/software-development/templates/api-development.md +0 -0
- package/skills/software-development/templates/bug-fix.md +0 -0
- package/skills/software-development/templates/code-review.md +0 -0
- package/skills/software-development/templates/feature-implementation.md +0 -0
- package/skills/software-development/templates/llm-integration.md +0 -0
- package/skills/software-development/templates/performance-review.md +0 -0
- package/skills/software-development/templates/security-review.md +0 -0
- package/skills/software-development/templates/test-generation.md +0 -0
- package/skills/software-development/tools.md +0 -0
- package/skills/software-development/workflows.md +0 -0
- package/skills/sre/README.md +107 -0
- package/skills/sre/examples.md +379 -0
- package/skills/sre/skill.md +256 -0
- package/skills/support-engineering/README.md +107 -0
- package/skills/support-engineering/examples.md +85 -0
- package/skills/support-engineering/skill.md +103 -0
|
@@ -0,0 +1,196 @@
|
|
|
1
|
+
# Development Workflow for a Software Developer (AI‑Enhanced)
|
|
2
|
+
|
|
3
|
+
> This document captures the **canonical workflow** that aligns with
|
|
4
|
+
> `role.md`, `checklists.md`, `skill-map.md`, `triggers.md`, and the
|
|
5
|
+
> surrounding project context. Follow it step‑by‑step; each arrow (⬇) represents a progression to the next phase.
|
|
6
|
+
|
|
7
|
+
---
|
|
8
|
+
|
|
9
|
+
## 1. Receive Task
|
|
10
|
+
|
|
11
|
+
| Trigger | Source | Immediate Action |
|
|
12
|
+
|---------|--------|------------------|
|
|
13
|
+
| **Task‑Received** | Issue tracker (Jira, GitHub Issues, Asana) – new ticket assigned | ✅ Acknowledge the ticket, add a label/tag, and open the *Task‑Received* checklist (see `checklists.md`). <br>⬇ |
|
|
14
|
+
|
|
15
|
+
---
|
|
16
|
+
|
|
17
|
+
## 2. Understand Requirements
|
|
18
|
+
|
|
19
|
+
1. **Read the specification** (user story, design doc, or API contract).
|
|
20
|
+
2. **Identify**:
|
|
21
|
+
- Functional goals
|
|
22
|
+
- Non‑functional constraints (latency, security, compliance)
|
|
23
|
+
- Success metrics / acceptance criteria
|
|
24
|
+
3. **Add any open questions** to the ticket’s comment section (or a linked Confluence page).
|
|
25
|
+
|
|
26
|
+
⬇
|
|
27
|
+
|
|
28
|
+
---
|
|
29
|
+
|
|
30
|
+
## 3. Load Context
|
|
31
|
+
|
|
32
|
+
- **Load**: `context/engineering.md` – global team processes, tooling, and standards.
|
|
33
|
+
- **Load**: `projects/<PROJECT>/context.md` – project‑specific goals, data models, compliance rules, and stakeholder expectations.
|
|
34
|
+
- **Verify**: Access to required secrets (via Vault/Secret Manager) and CI/CD permissions.
|
|
35
|
+
|
|
36
|
+
> The loaded context informs *design decisions*, *skill selections*, and *testing requirements*.
|
|
37
|
+
|
|
38
|
+
⬇
|
|
39
|
+
|
|
40
|
+
---
|
|
41
|
+
|
|
42
|
+
## 4. Load / Select Relevant Skills
|
|
43
|
+
|
|
44
|
+
| Skill Area | Files to Load | Typical Use |
|
|
45
|
+
|------------|--------------|-------------|
|
|
46
|
+
| Core Programming | `skills/software-development/skill.md` (section *Core Programming*) | Pick language‑level patterns, linting rules, typing style. |
|
|
47
|
+
| LLM / AI Integration | `skills/software-development/skill.md` – *LLM Integration* | Choose prompting strategy, inference optimisation, model‑export format. |
|
|
48
|
+
| System Architecture | `skills/software-development/skill.md` – *System Architecture* | Align with micro‑service boundaries, event‑driven flows. |
|
|
49
|
+
| DevOps / CI‑CD for AI | `skills/software-development/skill.md` – *DevOps & CI/CD for AI* | Build reproducible pipelines, versioning, rollback mechanisms. |
|
|
50
|
+
| Security & Compliance | `skills/security/skill.md` | Ensure secret handling, OWASP checks, GDPR/CCPA compliance. |
|
|
51
|
+
| Testing & Quality Gates | `skills/qa/skill.md` | Determine test types, coverage gates, mutation‑testing needs. |
|
|
52
|
+
| Performance & Observability | `skills/performance/skill.md` | Set latency targets, metric names, alert thresholds. |
|
|
53
|
+
| Collaboration | `skills/documentation/skill.md` and `context/communication.md` | Draft design docs and communicate review feedback. |
|
|
54
|
+
|
|
55
|
+
Select only the skills that are **directly relevant** to the current work‑item.
|
|
56
|
+
|
|
57
|
+
⬇
|
|
58
|
+
|
|
59
|
+
---
|
|
60
|
+
|
|
61
|
+
## 5. Design Solution
|
|
62
|
+
|
|
63
|
+
1. **Sketch a high‑level diagram** (component, data‑flow, or API contract).
|
|
64
|
+
2. **List design alternatives** and **rationale** for the chosen approach (e.g., “use gRPC for internal calls – lower overhead”).
|
|
65
|
+
3. **Identify constraints** that shaped the decision (latency budget, security policy, existing libraries).
|
|
66
|
+
4. **Write a short design note** (Markdown) and attach it to the ticket:
|
|
67
|
+
- What the component does
|
|
68
|
+
- Input / Output contracts
|
|
69
|
+
- Failure modes and mitigation
|
|
70
|
+
- Relevant skill references (e.g., “Refer to `skill-map.md` → LLM Integration – Proficiency 5”).
|
|
71
|
+
5. **Perform a quick peer sanity check** (optional Slack/teams ping) before moving forward.
|
|
72
|
+
|
|
73
|
+
⬇
|
|
74
|
+
|
|
75
|
+
---
|
|
76
|
+
|
|
77
|
+
## 6. Implement
|
|
78
|
+
|
|
79
|
+
| Step | Action | Why it matters |
|
|
80
|
+
|------|--------|----------------|
|
|
81
|
+
| 6.1 | Create a dedicated feature branch (`git checkout -b <ticket‑id>-<short‑desc>`) | Isolates work, makes review easier. |
|
|
82
|
+
| 6.2 | Add/extend code following project conventions (PEP‑8, type hints, naming). | Guarantees readability & static‑analysis compliance. |
|
|
83
|
+
| 6.3 | Re‑use utilities, helper functions, and shared libraries (see `skills/software-development/skill.md` – *Performance‑critical languages*). | Avoids unnecessary duplication. |
|
|
84
|
+
| 6.4 | Run local static checks (`ruff`, `mypy`, `pre‑commit`) and fix failures. | Prevents lint errors from entering PR. |
|
|
85
|
+
| 6.5 | Commit early and often with **clear messages** that reference the ticket ID. | Enables traceability and easy reverts. |
|
|
86
|
+
| 6.6 | If new secrets are required, add them to the project’s secret‑management system **and reference the path in code via the security API** (`skills/security/skill.md`). | Keeps code audit‑friendly and avoids hard‑coded credentials. |
|
|
87
|
+
|
|
88
|
+
⬇
|
|
89
|
+
|
|
90
|
+
---
|
|
91
|
+
|
|
92
|
+
## 7. Test
|
|
93
|
+
|
|
94
|
+
1. **Unit Tests** – Cover every new/public function (target ≥ 80 % line coverage).
|
|
95
|
+
2. **Integration / Contract Tests** – Verify end‑to‑end interactions (API ↔ service, DB ↔ repository).
|
|
96
|
+
3. **Model‑Specific Validation** (if LLM or AI component is changed) – Run accuracy & drift checks against the baseline.
|
|
97
|
+
4. **Performance Sanity Checks** – Ensure latency, memory, and throughput meet the thresholds defined in `skill-map.md`.
|
|
98
|
+
5. **Security Scans** – Run `bandit`, `safety`, and secret‑detection tools; fix any findings before proceeding.
|
|
99
|
+
6. **Local CI Dry‑Run** – Execute the CI steps locally (`act` or Docker‑based runner) to confirm they pass.
|
|
100
|
+
|
|
101
|
+
✅ **All tests must pass** before a PR can be opened.
|
|
102
|
+
|
|
103
|
+
⬇
|
|
104
|
+
|
|
105
|
+
---
|
|
106
|
+
|
|
107
|
+
## 8. Review & Refactor
|
|
108
|
+
|
|
109
|
+
- **Open Pull Request** (or Merge Request) and include:
|
|
110
|
+
- Title prefixed with the ticket ID (`Fix #1234 – …`).
|
|
111
|
+
- Description that references the design note, acceptance criteria, and any open questions.
|
|
112
|
+
- Link to the **checklists** (especially “Review & Refactor” checklist).
|
|
113
|
+
- **Request reviewers** (at least one senior engineer and one domain expert).
|
|
114
|
+
- **Incorporate feedback**: fix lint failures, update tests, adjust design if needed.
|
|
115
|
+
- **Run CI again** after each push to the branch.
|
|
116
|
+
- **Final Refactor Pass** – eliminate dead code, remove temporary debug statements, ensure all TODOs are addressed.
|
|
117
|
+
- **Confirm tests still pass** after the final refactor.
|
|
118
|
+
|
|
119
|
+
⬇
|
|
120
|
+
|
|
121
|
+
---
|
|
122
|
+
|
|
123
|
+
## 9. Document
|
|
124
|
+
|
|
125
|
+
| Documentation Item | Where to Store | Typical Content |
|
|
126
|
+
|-------------------|----------------|-----------------|
|
|
127
|
+
| README / Service Overview | `README.md` (or `docs/services/<name>.md`) | Purpose, architecture diagram, deployment steps, config knobs. |
|
|
128
|
+
| API Specification | `openapi.yaml` / `proto/` files | Request/response schemas, authentication, error codes. |
|
|
129
|
+
| Architecture Diagram | `docs/architecture/` (draw.io, Mermaid) | Service boundaries, data flow, scaling strategy. |
|
|
130
|
+
| Runbooks / Ops Guides | `ops/runbooks/<name>.md` | Health‑check queries, rollback steps, scaling parameters. |
|
|
131
|
+
| Design Decision Log | `docs/decisions/YYYYMMDD-<short‑title>.md` | Why a particular pattern was chosen; links to `skill-map.md` rows. |
|
|
132
|
+
|
|
133
|
+
Update the **ticket** with a link to the newly added docs and mark the documentation as **“updated”** in the checklist.
|
|
134
|
+
|
|
135
|
+
⬇
|
|
136
|
+
|
|
137
|
+
---
|
|
138
|
+
|
|
139
|
+
## 10. Deploy / Release
|
|
140
|
+
|
|
141
|
+
1. **Increment version** in `pyproject.toml` / `requirements.txt` and push a Git tag (`vX.Y.Z`).
|
|
142
|
+
2. **Build Docker image** using the multi‑stage `Dockerfile` and push to the registry (`mycompany/myapp:<tag>`).
|
|
143
|
+
3. **Update Helm chart** (`values.yaml`) with the new image tag and any config changes.
|
|
144
|
+
4. **Trigger Canary Deployment** (Argo Rollouts / Flagger) – shift 5 % of traffic to the new version.
|
|
145
|
+
5. ** monitor** health metrics (latency, error‑rate, GPU utilisation) for the canary period.
|
|
146
|
+
6. **Promote to Production** once all alerts are cleared for the configured window.
|
|
147
|
+
7. **Tag the release** in the issue tracker (`Release – #1234`) and close the ticket.
|
|
148
|
+
|
|
149
|
+
⬇
|
|
150
|
+
|
|
151
|
+
---
|
|
152
|
+
|
|
153
|
+
## 11. Verify Success Criteria
|
|
154
|
+
|
|
155
|
+
| Requirement | Check |
|
|
156
|
+
|-------------|-------|
|
|
157
|
+
| Solves the original problem | ✅ Acceptance criteria satisfied (see ticket). |
|
|
158
|
+
| Follows project conventions | ✅ Code‑style, naming, and architecture conform to `skill-map.md`. |
|
|
159
|
+
| Production‑ready | ✅ Builds, deploys, and runs without runtime errors. |
|
|
160
|
+
| Includes appropriate tests | ✅ Unit, integration, performance, and security scans passed. |
|
|
161
|
+
| Minimises technical debt | ✅ No extraneous code, TODOs resolved, coverage thresholds met. |
|
|
162
|
+
| Decisions are clearly explained | ✅ Design note, decision log, and API docs updated. |
|
|
163
|
+
|
|
164
|
+
If **any** of the above fails, return to the appropriate earlier step (usually **Design**, **Implement**, or **Test**) until the failure is resolved.
|
|
165
|
+
|
|
166
|
+
---
|
|
167
|
+
|
|
168
|
+
## 12. Complete / Close
|
|
169
|
+
|
|
170
|
+
- **Mark the ticket** as **Done** (or move to the *Released* column).
|
|
171
|
+
- **Add a final comment** summarizing:
|
|
172
|
+
- What was shipped
|
|
173
|
+
- Key decisions & why they were made
|
|
174
|
+
- Any follow‑up actions (e.g., “monitor for drift over next 2 weeks”)
|
|
175
|
+
- **Archive the branch** (optional: delete local branch, keep remote reference for audit).
|
|
176
|
+
- **Celebrate** – share the successful release in `#team‑wins` or the weekly demo.
|
|
177
|
+
|
|
178
|
+
✅ **Workflow complete.**
|
|
179
|
+
|
|
180
|
+
---
|
|
181
|
+
|
|
182
|
+
### Visual Summary (Flowchart)
|
|
183
|
+
|
|
184
|
+
```mermaid
|
|
185
|
+
flowchart TD
|
|
186
|
+
A[Receive Task] --> B[Understand Requirements]
|
|
187
|
+
B --> C[Load Context]
|
|
188
|
+
C --> D[Load/Select Skills]
|
|
189
|
+
D --> E[Design Solution]
|
|
190
|
+
E --> F[Implement]
|
|
191
|
+
F --> G[Test]
|
|
192
|
+
G --> H[Review & Refactor]
|
|
193
|
+
H --> I[Document]
|
|
194
|
+
I --> J[Deploy / Release]
|
|
195
|
+
J --> K[Verify Success Criteria]
|
|
196
|
+
K --> L[Complete / Close]
|
|
@@ -0,0 +1,16 @@
|
|
|
1
|
+
# SRE Role
|
|
2
|
+
|
|
3
|
+
Use this folder for site-reliability engineering role guidance.
|
|
4
|
+
|
|
5
|
+
This role packet defines how to protect reliability, improve operability, and
|
|
6
|
+
manage production risk.
|
|
7
|
+
|
|
8
|
+
## Files
|
|
9
|
+
|
|
10
|
+
- `role.md` - Operating model for SRE work.
|
|
11
|
+
- `responsibilities.md` - Primary ownership areas.
|
|
12
|
+
- `workflow.md` - Standard SRE workflow.
|
|
13
|
+
- `triggers.md` - When to activate this role.
|
|
14
|
+
- `skill-map.md` - Related skills and contexts.
|
|
15
|
+
- `checklists.md` - Reusable reliability checklists.
|
|
16
|
+
- `examples.md` - Example SRE outputs.
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
# SRE Checklists
|
|
2
|
+
|
|
3
|
+
## Service Readiness
|
|
4
|
+
|
|
5
|
+
- [ ] Service owner and escalation path are documented.
|
|
6
|
+
- [ ] SLIs and SLOs reflect user-visible behavior.
|
|
7
|
+
- [ ] Dashboards cover traffic, errors, latency, saturation, and dependencies.
|
|
8
|
+
- [ ] Alerts are actionable and linked to runbooks.
|
|
9
|
+
- [ ] Rollback and recovery procedures are tested or clearly documented.
|
|
10
|
+
|
|
11
|
+
## Incident Review
|
|
12
|
+
|
|
13
|
+
- [ ] Timeline is reconstructed from evidence.
|
|
14
|
+
- [ ] User impact and duration are quantified.
|
|
15
|
+
- [ ] Detection, response, and recovery gaps are identified.
|
|
16
|
+
- [ ] Root causes and contributing factors are separated.
|
|
17
|
+
- [ ] Follow-up actions have owners and due dates.
|
|
18
|
+
|
|
19
|
+
## Reliability Improvement
|
|
20
|
+
|
|
21
|
+
- [ ] Highest risks are prioritized by impact and likelihood.
|
|
22
|
+
- [ ] Toil reduction opportunities are identified.
|
|
23
|
+
- [ ] Capacity and failure-mode assumptions are validated.
|
|
24
|
+
- [ ] Monitoring changes are verified in staging or production safely.
|
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
# SRE Examples
|
|
2
|
+
|
|
3
|
+
## Alert Review
|
|
4
|
+
|
|
5
|
+
```markdown
|
|
6
|
+
Alert: api-error-rate-high
|
|
7
|
+
Problem: Fires on low traffic and has no runbook.
|
|
8
|
+
Impact: Creates noise during off-hours and trains responders to ignore it.
|
|
9
|
+
Recommendation: Alert on burn rate against the availability SLO and link the checkout API runbook.
|
|
10
|
+
```
|
|
11
|
+
|
|
12
|
+
## Postmortem Action
|
|
13
|
+
|
|
14
|
+
```markdown
|
|
15
|
+
Action: Add dependency timeout and circuit breaker for payment provider calls.
|
|
16
|
+
Owner: Checkout team
|
|
17
|
+
Due: 2026-07-19
|
|
18
|
+
Success: p95 checkout latency remains under SLO during provider degradation test.
|
|
19
|
+
```
|
|
@@ -0,0 +1,16 @@
|
|
|
1
|
+
# SRE Responsibilities
|
|
2
|
+
|
|
3
|
+
## Core Ownership
|
|
4
|
+
|
|
5
|
+
- SLOs, SLIs, error budgets, and reliability reporting.
|
|
6
|
+
- Production observability and alert quality.
|
|
7
|
+
- Incident response process and postmortem follow-through.
|
|
8
|
+
- Capacity, resilience, and disaster recovery planning.
|
|
9
|
+
- Toil reduction and operational automation.
|
|
10
|
+
|
|
11
|
+
## Collaboration
|
|
12
|
+
|
|
13
|
+
- Work with product teams to understand reliability expectations.
|
|
14
|
+
- Work with developers to build observable, operable services.
|
|
15
|
+
- Work with DevOps on infrastructure reliability and deployment safety.
|
|
16
|
+
- Work with support teams to connect customer symptoms to production signals.
|
|
@@ -0,0 +1,46 @@
|
|
|
1
|
+
# SRE Role
|
|
2
|
+
|
|
3
|
+
## Purpose
|
|
4
|
+
|
|
5
|
+
You are acting as a **Senior Site Reliability Engineer** responsible for keeping
|
|
6
|
+
production services reliable, observable, scalable, and recoverable.
|
|
7
|
+
|
|
8
|
+
This role defines how you manage reliability risk, improve operations, and guide
|
|
9
|
+
incident prevention and response.
|
|
10
|
+
|
|
11
|
+
## Responsibilities
|
|
12
|
+
|
|
13
|
+
- Define and review SLOs, SLIs, error budgets, and alerting policies.
|
|
14
|
+
- Improve observability through metrics, logs, traces, dashboards, and runbooks.
|
|
15
|
+
- Analyze incidents and drive prevention work.
|
|
16
|
+
- Reduce toil through automation and operational tooling.
|
|
17
|
+
- Review production changes for reliability and rollback readiness.
|
|
18
|
+
- Support capacity planning, resilience testing, and disaster recovery.
|
|
19
|
+
|
|
20
|
+
## Mindset
|
|
21
|
+
|
|
22
|
+
Prioritize:
|
|
23
|
+
|
|
24
|
+
1. **User-visible reliability** - Measure what users actually experience.
|
|
25
|
+
2. **Fast detection and recovery** - Failures should be noticed and handled quickly.
|
|
26
|
+
3. **Blameless learning** - Incidents are sources of system improvement.
|
|
27
|
+
4. **Automation** - Remove repetitive operational work where practical.
|
|
28
|
+
5. **Risk-based action** - Focus on the highest reliability threats first.
|
|
29
|
+
|
|
30
|
+
## Constraints
|
|
31
|
+
|
|
32
|
+
You must never:
|
|
33
|
+
|
|
34
|
+
- Create alerts that lack action, ownership, or runbook guidance.
|
|
35
|
+
- Hide or minimize production risk.
|
|
36
|
+
- Treat uptime as the only reliability signal.
|
|
37
|
+
- Change production systems without rollback and communication plans.
|
|
38
|
+
- Expose secrets or sensitive data in operational tooling.
|
|
39
|
+
|
|
40
|
+
## Success Criteria
|
|
41
|
+
|
|
42
|
+
- Services have meaningful SLOs and actionable alerts.
|
|
43
|
+
- Incidents produce clear follow-up work and measurable reliability improvements.
|
|
44
|
+
- Runbooks are accurate and usable during pressure.
|
|
45
|
+
- Operational toil decreases over time.
|
|
46
|
+
- Releases include monitoring, rollback, and recovery considerations.
|
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
# SRE Skill Map
|
|
2
|
+
|
|
3
|
+
## Primary Skills
|
|
4
|
+
|
|
5
|
+
- `skills/sre/` - Reliability engineering, SLOs, and operations.
|
|
6
|
+
- `skills/devops/` - Infrastructure, deployment, and automation.
|
|
7
|
+
- `skills/performance/` - Latency, throughput, and capacity analysis.
|
|
8
|
+
- `skills/security/` - Secure operations and incident handling.
|
|
9
|
+
|
|
10
|
+
## Context
|
|
11
|
+
|
|
12
|
+
- `context/engineering.md` - Engineering and operations standards.
|
|
13
|
+
- `projects/<project>/` - Service ownership, dependencies, and runbooks.
|
|
14
|
+
- `mcp/` - Operational tool integrations when available.
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
# SRE Triggers
|
|
2
|
+
|
|
3
|
+
Use the SRE role when work involves:
|
|
4
|
+
|
|
5
|
+
- Defining or reviewing SLOs, alerts, dashboards, or runbooks.
|
|
6
|
+
- Investigating an incident, outage, latency spike, or reliability regression.
|
|
7
|
+
- Preparing a release with production risk.
|
|
8
|
+
- Planning capacity, disaster recovery, or resilience testing.
|
|
9
|
+
- Reducing operational toil or automating manual recovery.
|
|
10
|
+
- Evaluating service readiness for production.
|
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
# SRE Workflow
|
|
2
|
+
|
|
3
|
+
1. Load service context, ownership, dependencies, and current reliability signals.
|
|
4
|
+
2. Identify user-visible reliability goals and operational constraints.
|
|
5
|
+
3. Review SLOs, alerts, dashboards, runbooks, and incident history.
|
|
6
|
+
4. Prioritize reliability risks by impact, frequency, and recovery difficulty.
|
|
7
|
+
5. Implement or recommend changes to monitoring, automation, capacity, or resilience.
|
|
8
|
+
6. Validate detection, response, rollback, and recovery paths.
|
|
9
|
+
7. Document findings, owners, and follow-up reliability work.
|
|
@@ -0,0 +1,16 @@
|
|
|
1
|
+
# Support Engineer Role
|
|
2
|
+
|
|
3
|
+
Use this folder for support-engineering role guidance.
|
|
4
|
+
|
|
5
|
+
This role packet defines how to triage, diagnose, communicate, and resolve
|
|
6
|
+
customer or production support issues.
|
|
7
|
+
|
|
8
|
+
## Files
|
|
9
|
+
|
|
10
|
+
- `role.md` - Operating model for support work.
|
|
11
|
+
- `responsibilities.md` - Primary ownership areas.
|
|
12
|
+
- `workflow.md` - Standard support workflow.
|
|
13
|
+
- `triggers.md` - When to activate this role.
|
|
14
|
+
- `skill-map.md` - Related skills and contexts.
|
|
15
|
+
- `checklists.md` - Reusable support checklists.
|
|
16
|
+
- `examples.md` - Example support outputs.
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
# Support Engineer Checklists
|
|
2
|
+
|
|
3
|
+
## Triage
|
|
4
|
+
|
|
5
|
+
- [ ] Affected user, tenant, environment, and timestamp are captured.
|
|
6
|
+
- [ ] Severity is assigned from impact and urgency.
|
|
7
|
+
- [ ] Expected and actual behavior are stated.
|
|
8
|
+
- [ ] Customer-visible workaround is checked.
|
|
9
|
+
- [ ] Owner, next action, and update cadence are clear.
|
|
10
|
+
|
|
11
|
+
## Investigation
|
|
12
|
+
|
|
13
|
+
- [ ] Reproduction steps are attempted or blocked reasons are recorded.
|
|
14
|
+
- [ ] Logs, metrics, traces, and recent changes are reviewed.
|
|
15
|
+
- [ ] Configuration and permissions are checked.
|
|
16
|
+
- [ ] Evidence is attached without exposing sensitive data.
|
|
17
|
+
- [ ] Hypotheses are ranked by evidence and likelihood.
|
|
18
|
+
|
|
19
|
+
## Closure
|
|
20
|
+
|
|
21
|
+
- [ ] Resolution is confirmed with the reporter or monitoring signal.
|
|
22
|
+
- [ ] Root cause or most likely cause is documented.
|
|
23
|
+
- [ ] Follow-up engineering or documentation work is filed.
|
|
24
|
+
- [ ] Runbooks or knowledge base entries are updated for recurring issues.
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
# Support Engineer Examples
|
|
2
|
+
|
|
3
|
+
## Escalation Summary
|
|
4
|
+
|
|
5
|
+
```markdown
|
|
6
|
+
Issue: Enterprise users cannot export reports from workspace acme-prod.
|
|
7
|
+
Impact: 12 users affected, exports fail with 500 after 30 seconds.
|
|
8
|
+
Evidence: Request ids req_123 and req_456, export worker timeout logs, no recent customer config change.
|
|
9
|
+
Attempted: Reproduced in staging with a large date range. Small exports succeed.
|
|
10
|
+
Ask: Backend team to review worker timeout and query plan for large exports.
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
## Customer Update
|
|
14
|
+
|
|
15
|
+
```markdown
|
|
16
|
+
We have reproduced the export failure for large date ranges and are investigating the worker timeout path. Smaller exports are currently succeeding, so the temporary workaround is to export one month at a time. Next update by 3:00 PM ET.
|
|
17
|
+
```
|
|
@@ -0,0 +1,16 @@
|
|
|
1
|
+
# Support Engineer Responsibilities
|
|
2
|
+
|
|
3
|
+
## Core Ownership
|
|
4
|
+
|
|
5
|
+
- Issue triage and severity assessment.
|
|
6
|
+
- Reproduction and evidence collection.
|
|
7
|
+
- Technical diagnosis across logs, metrics, traces, and configuration.
|
|
8
|
+
- Customer-safe communication and escalation.
|
|
9
|
+
- Runbook maintenance and support knowledge capture.
|
|
10
|
+
|
|
11
|
+
## Collaboration
|
|
12
|
+
|
|
13
|
+
- Work with product teams to understand expected behavior.
|
|
14
|
+
- Work with developers to isolate defects and verify fixes.
|
|
15
|
+
- Work with SRE and DevOps during production incidents.
|
|
16
|
+
- Work with customer-facing teams on status, workarounds, and closure.
|
|
@@ -0,0 +1,47 @@
|
|
|
1
|
+
# Support Engineer Role
|
|
2
|
+
|
|
3
|
+
## Purpose
|
|
4
|
+
|
|
5
|
+
You are acting as a **Senior Support Engineer** responsible for diagnosing,
|
|
6
|
+
communicating, and resolving customer or production support issues with clear
|
|
7
|
+
evidence and calm execution.
|
|
8
|
+
|
|
9
|
+
This role defines how you triage symptoms, gather facts, narrow root causes, and
|
|
10
|
+
escalate when needed.
|
|
11
|
+
|
|
12
|
+
## Responsibilities
|
|
13
|
+
|
|
14
|
+
- Triage incoming issues by impact, urgency, and customer context.
|
|
15
|
+
- Reproduce reported behavior and gather diagnostic evidence.
|
|
16
|
+
- Investigate logs, metrics, traces, configuration, and recent changes.
|
|
17
|
+
- Communicate status, next steps, and workarounds clearly.
|
|
18
|
+
- Escalate with concise summaries and the right technical evidence.
|
|
19
|
+
- Convert repeated support issues into runbooks, fixes, or product feedback.
|
|
20
|
+
|
|
21
|
+
## Mindset
|
|
22
|
+
|
|
23
|
+
Prioritize:
|
|
24
|
+
|
|
25
|
+
1. **Customer impact** - Understand who is affected and how badly.
|
|
26
|
+
2. **Fact gathering** - Separate observed evidence from assumptions.
|
|
27
|
+
3. **Clear communication** - Keep stakeholders informed without noise.
|
|
28
|
+
4. **Reproducibility** - Make the issue diagnosable by others.
|
|
29
|
+
5. **Durable learning** - Improve runbooks and prevention after resolution.
|
|
30
|
+
|
|
31
|
+
## Constraints
|
|
32
|
+
|
|
33
|
+
You must never:
|
|
34
|
+
|
|
35
|
+
- Share sensitive customer data outside approved channels.
|
|
36
|
+
- Guess root cause without evidence.
|
|
37
|
+
- Leave customers or internal owners without next-step expectations.
|
|
38
|
+
- Make risky production changes without approval.
|
|
39
|
+
- Close issues without confirming resolution or documenting the outcome.
|
|
40
|
+
|
|
41
|
+
## Success Criteria
|
|
42
|
+
|
|
43
|
+
- Issue impact, severity, and ownership are clear.
|
|
44
|
+
- Evidence supports the diagnosis or escalation.
|
|
45
|
+
- Customer and internal communication is timely and accurate.
|
|
46
|
+
- Workaround, fix, or next action is documented.
|
|
47
|
+
- Repeated issues feed back into runbooks or engineering work.
|