StackPractices

Documentation Templates

Reusable technical documentation templates for software teams: READMEs, ADRs, runbooks, guidelines, and more.

177 results

advanced

AI Agent Design Document Template

Document AI agent architecture, tools, memory, reasoning patterns, safety guardrails, evaluation...

intermediate

AI Data Preparation Checklist

Checklist for preparing data for LLM and RAG systems: data collection, cleaning, chunking,...

intermediate

AI LLM Cost Tracking Template

Track token usage and costs per feature, model, and user. Includes cost categories, pricing tables,...

advanced

AI LLM Incident Response Runbook

Operational runbook for LLM production incidents: hallucination events, model outages, cost spikes,...

intermediate

AI LLM Prompt Template Library

A reusable prompt template library for common LLM tasks: summarization, extraction, classification,...

intermediate

AI Model Selection Matrix

Compare LLM models by cost, latency, context window, accuracy, and use case. Includes decision...

ai llm model-selection matrix
intermediate

AI Prompt Version Control Template

Version your LLM prompts with eval scores, change history, rollback support, and A/B testing....

intermediate

AI RAG Evaluation Checklist

A checklist for evaluating RAG system quality: retrieval accuracy, generation faithfulness, context...

beginner

API Changelog Template

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

beginner

API Deprecation Notice Template

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

beginner

API Error Handling Guideline

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

intermediate

API Rate Limiting Policy Template

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

intermediate

SLA Definition Template

A template for defining and documenting Service Level Agreements including uptime targets, response...

intermediate

API Lifecycle Management Template

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

intermediate

API Monitoring & Alerting Template

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

intermediate

API Performance Budget Template

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

intermediate

Microservice Contract Template

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

intermediate

Service Dependency Map Template

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

beginner

System Diagram Template

A template for creating C4 model and architecture diagram standards.

intermediate

Technical Specification Template

Use this technical specification template to document requirements, design decisions, architecture,...

No results found.