Documentation

Document AI agent architecture, tools, memory, reasoning patterns, safety guardrails, evaluation criteria, and deployment configuration. Includes sections for system prompts, tool definitions, and failure modes.

Checklist for preparing data for LLM and RAG systems: data collection, cleaning, chunking, embedding, deduplication, PII removal, format validation, quality scoring, and indexing with metrics and thresholds.

Track token usage and costs per feature, model, and user. Includes cost categories, pricing tables, budget alerts, optimization strategies, and reporting templates for LLM API spending.

Operational runbook for LLM production incidents: hallucination events, model outages, cost spikes, safety failures, and degraded quality. Includes severity levels, escalation paths, diagnostic steps, and recovery procedures.

A reusable prompt template library for common LLM tasks: summarization, extraction, classification, code review, translation, and structured output with variables, examples, and evaluation criteria.

Compare LLM models by cost, latency, context window, accuracy, and use case. Includes decision criteria, benchmark results, pricing comparison, and recommendations for classification, extraction, summarization, code, and agent tasks.

Version your LLM prompts with eval scores, change history, rollback support, and A/B testing. Includes prompt metadata schema, changelog format, evaluation tracking, and CI/CD integration for prompt management.

A checklist for evaluating RAG system quality: retrieval accuracy, generation faithfulness, context relevance, answer correctness, citation accuracy, latency, and end-to-end testing with metrics and thresholds.

A template for documenting API changes including breaking changes, new features, deprecations, and bug fixes.

A template for communicating API deprecations, breaking changes, and sunset timelines to consumers.

A guideline for standardizing error responses, status codes, and error payloads across REST and GraphQL APIs.

A template for defining API rate limits per consumer tier, including burst allowances, quota periods, and escalation paths.

A template for defining and documenting Service Level Agreements including uptime targets, response times, error budgets, and escalation procedures.

A checklist template for API deprecation, versioning, and sunset procedures.

A template for defining API SLA thresholds, error rate alerts, and monitoring dashboards.

A template for setting and tracking API latency and throughput performance budgets.

A template for defining service contracts and API agreements between microservices.

A template for documenting and visualizing service dependencies in distributed systems.

A template for creating C4 model and architecture diagram standards.

A template for writing technical specification documents for software projects.

Template for documenting cache eviction rules per cache layer: LRU, LFU, TTL, FIFO, random eviction. Includes policy selection matrix, per-layer configuration, memory limits, and monitoring rules with code examples.

Decision template for choosing cache strategies per use case: no-cache, cache-aside, read-through, write-through, write-back, and refresh-ahead. Includes decision matrix, TTL guidelines, invalidation rules, and code examples.

Runbook for warming caches after deployment, restart, or incident: identify hot keys, preload strategies, progressive warmup, health checks, and rollback procedures with code examples and automation scripts.

Template for defining CDN caching rules and edge behavior: cache keys, TTL by content type, query parameter handling, header forwarding, purge strategies, and origin shield configuration with code examples.

Runbook for safely cancelling long-running async tasks in Python, JavaScript, Go, and Java: cancellation tokens, context propagation, resource cleanup, timeout strategies, and graceful shutdown procedures with code examples.

Checklist for identifying and fixing race conditions in concurrent code: symptom identification, reproduction strategies, debugging tools, common patterns, fixes using locks, atomics, channels, and prevention techniques with code examples.

Template for documenting thread pool configuration per service: pool type selection, sizing formulas, CPU vs I/O bound tuning, queue strategies, rejection policies, monitoring metrics, and tuning examples for Java, Python, Go, and Node.js.

A template for data classification, retention, access control, privacy, and compliance policies covering GDPR, CCPA, and SOC 2 requirements.

A template for documenting data pipeline sources, transformations, sinks, scheduling, error handling, and monitoring with schema definitions.

A template for defining data validation rules per dataset and column: completeness, consistency, accuracy, timeliness, and uniqueness checks.

A runbook for operating, monitoring, and troubleshooting ETL jobs: startup, shutdown, health checks, common failures, diagnostics, and recovery.

A template for auditing user access rights, verifying least privilege, and documenting access decisions across systems and teams.

A lightweight template for documenting major architectural decisions, their context, options considered, and the reasoning behind the chosen approach.

A template for documenting scale-up and scale-down rules for cloud infrastructure.

A template for documenting database and file backup verification procedures.

A template to plan and document backup verification tests, ensuring restore procedures work before an emergency.

A template for classifying and routing bug reports by severity and impact.

A structured template for forecasting infrastructure growth, identifying resource bottlenecks, and planning capacity before traffic surges cause outages.

A template for documenting CAB reviews and rollback criteria for production changes.

A template for documenting CI/CD pipeline stages, gates, environments, deployment strategies, rollback procedures, and security scanning.

A template for securing build and deployment pipelines against credential leaks, tampering, supply chain attacks, and unauthorized deployments.

A template for tracking team and environment cloud cost allocation.

A policy template for enforcing consistent labels on cloud resources to improve cost allocation, security, and operations.

A structured checklist template for conducting consistent, thorough code reviews that catch bugs, improve readability, and share knowledge across the team.

A template for mapping current security controls to compliance frameworks like SOC 2, ISO 27001, and PCI-DSS.

A baseline template for hardening container images, runtimes, and orchestration configurations across environments.

A template for documenting multi-region disaster recovery test procedures.

A step-by-step playbook for responding to security incidents involving unauthorized data access, from initial detection through notification and remediation.

A runbook template for safely migrating data between systems including pre-migration checks, rollback procedures, and post-migration validation.

A template to define how long data is kept, when it is archived, and when it must be deleted for compliance and cost reasons.

A step-by-step runbook for upgrading project dependencies safely.

A template for documenting security findings in dependencies, including severity, impact, and remediation steps for engineering teams.

A pre-release verification checklist for safe production deployments.

Runbook for rolling back failed deployments safely: rollback triggers, Kubernetes rollback, blue-green deployment rollback, canary rollback, database migration rollback, verification steps, and post-rollback procedures with code examples for kubectl, Helm, and ArgoCD.

A template for planning and communicating the sunset of legacy capabilities, APIs, or services with clear milestones and stakeholder notifications.

A template for planning and executing disaster recovery tests including failover validation, data integrity checks, and recovery time measurement.

Checklist for hardening Docker container images for production: base image selection, user permissions, file system restrictions, network isolation, resource limits, secret management, vulnerability scanning, and CI/CD integration with Dockerfile examples.

A template for internal and external outage messaging during service downtime.

A template for managing the creation, distribution, rotation, and destruction of encryption keys across applications and services.

A checklist template for hardening laptops, workstations, and mobile devices that access corporate data and systems.

A template for documenting team culture, development processes, technical standards, and operational practices in a single referenceable handbook.

A template to document environment variables, secrets, endpoints, and infrastructure settings per deployment environment.

A template for defining incident severity levels and on-call escalation paths.

A template for writing clear, actionable feature specifications that align engineering, product, and design before development begins.

A document template for defining Git workflow, branching conventions, merge requirements, and release procedures for engineering teams.

A checklist for reviewing Helm charts covering values, templates, security, resource limits, probes, RBAC, and best practices.

A template for notifying stakeholders during production outages with pre-drafted messages for each incident severity level and audience type.

A template for reconstructing the exact sequence of events during incident investigations to identify detection gaps and response delays.

A template for reviewing Terraform and CloudFormation infrastructure code.

A template for assigning cloud infrastructure costs to teams, products, or environments with consistent tagging and chargeback rules.

A template for defining Pod Disruption Budgets to control voluntary disruptions during node drains, upgrades, and maintenance windows.

Template for defining Kubernetes resource quotas per namespace: CPU and memory limits, object count quotas, storage quotas, LimitRanges for default requests, priority class integration, and monitoring with examples for multi-tenant clusters.

A template to plan, execute, and document load tests that measure system behavior under realistic or peak traffic.

A document template for defining structured logging conventions, log levels, retention, and observability requirements across services.

A policy template that defines how alerts are configured, routed, escalated, and reviewed across services and infrastructure.

A template for documenting VPC, firewall, and DNS security rules inventory.

A template for documenting network security zones, segmentation rules, and traffic controls between environments and tenants.

A template for transferring operational context between on-call shifts including active incidents, ongoing alerts, and system health status.

A template documenting common alerts and step-by-step response procedures for on-call engineers.

A thorough checklist for onboarding new backend engineers covering environment setup, codebase orientation, security training, and first-week goals.

A template for scheduling, testing, and deploying security patches across environments.

A template for defining the boundaries, targets, rules, and deliverables for a penetration testing engagement.

A template for comparing benchmarks and creating action plans when performance degrades.

A blameless postmortem template for analyzing incidents, identifying root causes, and documenting lessons to prevent recurrence.

A thorough checklist for verifying that a service, feature, or system is ready for production deployment and ongoing operation.

A template for defining role-based access control policies, including roles, permissions, assignment rules, and review cadence.

A template for release notes and stakeholder updates during capability rollouts.

A step-by-step runbook for executing database failover procedures safely with minimal downtime and data loss.

A template for tracking and scheduling the rotation of API keys, passwords, certificates, and other secrets across systems.

A template for defining reliability targets, error budgets, and measurement methods for services and systems.

A template for defining SLOs, SLIs, and error budgets for reliable service management.

A template for defining who owns a service, what it does, how to operate it, and where to find critical information when things go wrong.

A template for tracking TLS/SSL certificate inventory, renewals, deployments, and expiration risks across domains and services.

A template for tracking SSL certificate expiration and renewal workflows.

A checklist for safely retiring old services, removing dependencies, and cleaning up infrastructure without breaking downstream consumers.

Policy for versioning and publishing Terraform modules: semantic versioning rules, breaking change management, module registry publishing, changelog requirements, deprecation process, and CI/CD integration with examples for Terraform Cloud and private registries.

A policy for managing Terraform state files: backend configuration, locking, isolation, access control, versioning, and disaster recovery.

A structured template for evaluating the security, compliance, and operational posture of third-party vendors before onboarding or renewal.

A template for reviewing and certifying user access rights across systems, applications, and data repositories.

A template for summarizing vulnerability scan findings, including asset coverage, severity distribution, and remediation tracking.

A template for summarizing incidents, costs, performance, and action items in weekly operations reviews.

A checklist to ensure production deployments complete without service interruptions using safe rollout patterns.

A WCAG 2.2 compliance checklist covering perceivable, operable, understandable, and robust criteria with testing tools and remediation steps.

A template for tracking browser support targets, feature compatibility, polyfill requirements, and fallback strategies across the browser matrix.

A template for documenting UI component APIs: props, events, slots, methods, accessibility, and usage examples with TypeScript types.

A template for defining JS, CSS, image, and font budgets per route with enforcement strategies and monitoring thresholds.

Internal guidelines for designing GraphQL APIs: schema structure, naming, mutation patterns, error handling, pagination, authentication, rate limiting, versioning, and federation rules with code examples.

Policy template for deprecating GraphQL fields, types, arguments, and enum values safely. Includes deprecation timeline, communication plan, usage tracking, removal criteria, and migration examples.

Template for onboarding a service to a federated GraphQL graph: subgraph setup, entity definitions, resolver configuration, gateway integration, testing, deployment, and monitoring with code examples.

Checklist for reviewing GraphQL schemas: naming conventions, type design, pagination, error handling, security, performance, deprecation, and federation readiness with code examples and validation rules.

Runbook for handling and replaying dead letter queue messages in Kafka and RabbitMQ: DLQ setup, inspection procedures, root cause analysis, replay strategies, monitoring alerts, and automation scripts for failed message recovery.

Template for standardizing Kafka topic names across teams: naming patterns, environment prefixes, domain segmentation, event type suffixes, partition count rules, and retention policies with examples.

Policy for evolving message schemas safely in event-driven systems: backward and forward compatibility rules, schema registry usage, versioning strategies, migration procedures, and breaking change handling with Avro, Protobuf, and JSON examples.

Template for documenting RabbitMQ queue, exchange, and binding design: exchange types, queue properties, binding rules, dead letter handling, TTL policies, and capacity planning with code examples.

A standardized runbook for responding to alerts: triage, diagnosis, mitigation, resolution, and post-incident steps with escalation paths.

A template for designing observability dashboards with SLOs, error budgets, service health, and contextual information for on-call teams.

A blameless postmortem template for documenting incidents: timeline, impact, root cause, contributing factors, and action items with owners.

A template for assessing logging, metrics, and tracing maturity across teams with scoring, gap analysis, and improvement roadmap.

Checklist for auditing Core Web Vitals per page: LCP optimization steps, INP interaction tuning, CLS layout stability fixes, field data vs lab data analysis, CrUX integration, and remediation tracking with code examples for images, fonts, JavaScript, and CSS.

Checklist for systematic SQL query optimization: EXPLAIN plan analysis, index strategy, N+1 query detection, join optimization, pagination patterns, connection pooling, query caching, and slow query log triage with examples for PostgreSQL and MySQL.

Template for planning and documenting load tests: test scenarios, user journey definitions, ramp-up strategies, success criteria, monitoring setup, tool selection (k6, JMeter, Locust), result analysis, and reporting with code examples for each tool.

Template for defining and enforcing web performance budgets: LCP, INP, CLS targets, resource budgets for JS, CSS, images, fonts, third-party scripts, CI/CD integration with Lighthouse CI, and alerting thresholds with examples for Next.js, Astro, and SPA architectures.

A template for defining authentication, authorization, RBAC, ABAC, MFA, password policies, session management, and access review procedures.

Template for documenting API authentication flows and token lifecycle: auth scheme selection, token types, issuance, validation, refresh, revocation, MFA, OAuth2 flows, JWT configuration, and security best practices with code examples.

A checklist template for reviewing API authentication, rate limiting, and OWASP compliance.

A template for classifying data as public, internal, confidential, or restricted with handling rules.

Template for triaging CVEs by severity and impact: vulnerability scoring, exploitability assessment, blast radius analysis, fix prioritization, patch testing, and deployment procedures with Snyk, Dependabot, and OWASP Dependency-Check examples.

A runbook for encryption key rotation covering key types, rotation schedules, zero-downtime procedures, dual-key migration, verification, and rollback.

A template for incident response covering severity classification, roles, detection, containment, eradication, recovery, and post-incident review procedures.

A step-by-step playbook template for handling security incidents.

Checklist for tracking OWASP Top 10 vulnerability remediation per application: risk assessment, fix priority, code-level remediation steps, verification testing, and compliance reporting with examples for each OWASP category.

A template for tracking security findings, assigning remediation owners, and validating fixes after penetration tests.

A template for penetration test reports covering scope, methodology, findings, severity ratings, evidence, and remediation recommendations.

Runbook for rotating secrets without downtime: secret inventory, rotation schedule, zero-downtime rotation strategies, dual-key periods, automated rotation with AWS Secrets Manager and HashiCorp Vault, and emergency rotation procedures.

A template for scheduling and tracking the rotation of API keys, tokens, and certificates.

A checklist for security audits covering network security, application security, data protection, access control, monitoring, incident response, and compliance.

A thorough checklist for conducting security audits of applications and infrastructure.

A template for security incident response covering detection, classification, containment, eradication, recovery, communication, and post-incident review.

Checklist for security checks during pull request review: input validation, authentication, authorization, secrets, dependencies, injection, XSS, CSRF, logging, and automated tooling integration with code examples for secure patterns.

A template for evaluating third-party vendor security and operational risks.

A template for vulnerability management covering discovery, triage, prioritization, remediation SLAs, verification, and reporting procedures.

A repeatable template for tracking vulnerabilities, assigning remediation owners, defining patching timelines, and reporting security risks to stakeholders.

Runbook for diagnosing and mitigating serverless cold starts: causes, measurement, optimization strategies (provisioned concurrency, warmers, initialization tuning), and monitoring with code examples for AWS Lambda, Azure, and GCP.

Template for estimating serverless costs per workload: invocation-based pricing, memory-duration calculation, data transfer, API Gateway, Step Functions, and hidden costs. Includes cost optimization strategies and monthly budget projections.

Pre-deploy and post-deploy checklist for serverless functions (AWS Lambda, Azure Functions, GCP Cloud Functions): IAM roles, environment variables, memory sizing, timeout config, logging, alarms, and rollback procedures.

Security hardening checklist for serverless functions: IAM least privilege, secret management, input validation, dependency scanning, network isolation, logging, and compliance with code examples for AWS Lambda, Azure, and GCP.

A reusable template for Architecture Decision Records that capture context, decision, and consequences.

A reusable template for documenting REST and GraphQL APIs with endpoints, schemas, errors, and examples.

A reusable template for consistent, informative, and developer-friendly API error responses that reduce debugging time.

A template for a public API status page that communicates uptime, incidents, and maintenance windows to consumers.

A structured bug report template to help teams reproduce, triage, and resolve defects faster with clear reproduction steps and expected behavior.

A reusable template for planning system capacity, estimating growth, and preventing performance bottlenecks before they happen.

A structured changelog template following Keep a Changelog conventions for tracking project releases.

A community code of conduct template to establish inclusive, respectful collaboration standards.

A ready-to-use template for open-source and internal project contribution guidelines.

A database migration runbook template for executing schema changes safely with rollback procedures, verification steps, and communication plans.

A template for documenting database schemas with entity relationships, field definitions, and migration history.

A template for auditing third-party dependencies: license compliance, security vulnerabilities, maintenance health, and supply chain risk.

A disaster recovery plan template for documenting RTO/RPO targets, failover procedures, and recovery runbooks that minimize downtime during catastrophic failures.

A template for documenting how to set up local development, staging, and production environments consistently and reproducibly.

A structured capability request template to help teams evaluate, prioritize, and implement new capabilities with clear user value and acceptance criteria.

A thorough onboarding guide template to help new team members get productive quickly.

A penetration test report template for documenting findings, risk ratings, reproduction steps, and remediation guidance for security assessments.

A checklist template for verifying deployments: health checks, smoke tests, metric validation, and rollback readiness before declaring all-clear.

A thorough pull request template to standardize code reviews and improve merge quality.

A production-ready README template for open-source and internal projects.

A release notes template that communicates changes clearly to users, operators, and stakeholders with categories, upgrade instructions, and known issues.

A reusable template for operational runbooks: incident response, deployment procedures, and routine tasks.

An SLO document template that defines reliability targets, error budgets, and escalation policies for services and platforms.

A user story template that connects user needs to implementation with clear acceptance criteria, definition of done, and INVEST principles.

A template for planning contract tests, integration tests, and load tests for APIs.

A template for writing minimal, reliable bug reproduction steps that help developers reproduce and fix issues quickly.

A standardized template for documenting load test results and recommendations.

A checklist for verifying existing functionality after changes: pre-deploy checks, post-deploy smoke tests, and rollback verification.

A standardized test case format with steps, expected results, preconditions, and postconditions for manual and automated testing.

A template for reporting test coverage by module, feature, and critical path with trend analysis and gap identification.

A template for documenting test approach per project: pyramid, scope, environments, tools, CI/CD gates, and quality metrics.