Skip to content

documentation

9 posts

documentation
Engineering Team Documentation: Working Agreements, Definition of Done, and On-Call Docs

The team documents a mature engineering team owns: onboarding, working agreements, Definition of Done, on-call, knowledge transfer, and what makes each one good.

engineering-culture · hiring · documentation +4

Amazon Bedrock Knowledge Bases Explained: Data Sources and Vector Stores

What a Bedrock Knowledge Base really is, which data sources and vector stores are first-class, and why the console default rarely fits a small corpus.

aws · aws-bedrock · rag +3

RAG Architecture Patterns: Beyond Basic Vector Search

A comprehensive guide to advanced RAG techniques including hybrid search, reranking, GraphRAG, and self-corrective patterns with production AWS implementation examples.

rag · llm · vector-databases +4

How to Write a Technical RFC: Section-by-Section Guide

A section-by-section guide to technical RFCs: what each part has to establish, what reviewers look for, and where proposals stall in review.

rfc · documentation · architecture +3

How to Write an Effective RFC: A Guide for Engineers

Practical guidance on RFC structure, stakeholder review, and turning technical debates into decisions a team actually keeps.

rfc · documentation · architecture +3

Bus Factor in Engineering Teams: How to Reduce Knowledge Risk

Protect your team from single points of failure through knowledge distribution, documentation strategies, and systematic risk management.

team-management · documentation · knowledge-sharing +5

Documentation as Infrastructure: Scaling Knowledge Across Engineering Teams

Documentation debt can slow teams faster than technical debt. A guide to treating docs as critical infrastructure and scaling knowledge across engineering teams.

documentation · rfc · team-management +3

Mermaid Diagram Types: Examples of Every Chart Type

Every Mermaid diagram type with a copy-ready example: flowcharts, sequence and class diagrams, ER models, Gantt charts, journeys, and more

documentation · tutorial

Complete Markdown Typography Guide

Every markdown typography and formatting feature, from headings and tables to footnotes, definition lists, and admonitions.

documentation · tutorial