Skip to main content

2 posts tagged with "devops"

View All Tags

Writing for the Engineer Who Will Replace You

· 5 min read
Faith Wachukwu
Documentation Engineer
An engineer working in the dark.

You’re staring at internal documentation at 11 PM, trying to figure out why a deployment pipeline is failing, but it's incomplete. It looks like whoever wrote it stopped midway, like they got pulled into a meeting and never came back. Well, what matters now is that you’re stuck.

As someone who has been in this situation, you should think differently when writing documentation about who you’re writing for and how they would feel with incomplete docs. In this post, you’ll learn how to approach documentation as an engineer.

Docs and Deployments: The Power of Clear Documentation in DevOps

· 5 min read
Faith Wachukwu
Documentation Engineer

DevOps teams love talking about automation, observability, infrastructure as code, and deployment speed. But what usually determines whether systems survive incidents, handoffs, or employee exits is accurate documentation.

For teams to ship reliably, they need up-to-date runbooks, READMEs, and architecture docs. In this post, you’ll learn why documentation is non-negotiable in DevOps, the types of documentation in DevOps, best practices and common challenges, and how to overcome them. Let’s dive right in.