Blog category
20 WebSnips articles on developer knowledge.
20 published articles
How to build a knowledge base for a dev team — a practical guide for engineering teams who want a shared knowledge system that engineers actually use, that stays current as the team grows, and that reduces the time engineers spend re-answering the same questions.
How to document a microservices architecture — a practical guide for engineering teams navigating service sprawl, where the challenge is not documenting individual services but making the relationships, contracts, and operational behavior of a distributed system legible.
How to keep a changelog developers trust — a practical guide for engineering teams who want a CHANGELOG.md that consumers of their API or library actually read and rely on, rather than a dump of commit messages that obscures more than it reveals.
How to save and organize design docs — a practical guide for engineers and engineering teams who want their design documents to remain findable, useful, and connected to the decisions they documented, rather than accumulating in an untended archive.
How to take notes during code review — a practical guide for engineers who want to get more from code review than the immediate feedback loop: building a personal reference of patterns, anti-patterns, and architectural decisions accumulated across months of reviews.
How to track tech-debt decisions — a practical guide for engineering teams who want to manage their technical debt as intentional trade-offs rather than accumulated accidents, with a tracking system that makes debt visible, prioritizable, and repayable.
How to build a personal developer wiki — a practical guide for software engineers who want a searchable, maintained personal knowledge base that captures the system-specific context, mental models, and workflow knowledge that makes them effective — and keeps it accessible over years.
How to build a reading list for system design — a practical guide for engineers who want a structured, curated reading path for system design, from foundational concepts to advanced distributed systems, without spending weeks figuring out what to read and in what order.
How to capture knowledge before a teammate leaves — a practical guide for engineering teams who want to prevent the knowledge loss that occurs when an engineer departs, using a structured knowledge transfer process that works even in a compressed timeline.
How to document an API for your team — a practical guide for engineers and tech leads who want to write API documentation that actually gets used: structured, accurate, kept current, and written at the level of detail that makes a new team member productive without a tour guide.
How to document onboarding for new developers — a practical guide for engineering teams who want new engineers to become productive in days rather than weeks, using documented onboarding that works without a dedicated guide and stays accurate after the hundredth hire.
How to keep a debugging journal — a practical guide for developers who want to stop re-discovering the same bugs, reduce debugging time by building a searchable record of past investigations, and turn frustrating debugging sessions into durable knowledge.
How to keep a learning log as an engineer — a practical guide for software engineers who want a structured system for capturing what they're learning week by week, so that growth is visible, patterns emerge, and the record is useful for performance reviews and career development.
How to manage code snippets — a practical guide for developers who have accumulated useful code across Gists, Notion pages, browser bookmarks, and editor scratch files, and want a system that makes any snippet findable in under 30 seconds without hunting through old projects.
How to organize technical documentation — a practical guide for engineering teams who want documentation that engineers actually read and maintain, organized so the right document is findable in under a minute without knowing where to look.
How to run a blameless postmortem — a practical guide for engineering teams who want to learn from incidents rather than repeat them, using a structured process that identifies systemic causes without assigning personal blame and produces action items that actually get closed.
How to save Stack Overflow answers you'll need again — a practical guide for developers who are tired of finding the same answer for the third time and want a system that turns their most-used Stack Overflow discoveries into a searchable, annotated personal reference.
How to write architecture decision records (ADRs) — a practical guide for engineers and tech leads who want to document the significant architectural decisions their team makes, so future contributors understand not just what the system does but why it was built that way.
How to write RFCs that get read — a practical guide for engineers who want their technical proposals to receive genuine engagement rather than being ignored or rubber-stamped, through a document structure that makes the trade-offs legible and the decision required.
How to write runbooks that people read — a practical guide for engineers and SREs who want operational runbooks that actually get used during incidents, not documentation that gets discovered after the incident is resolved and is outdated by the time it's needed.