From Messy READMEs to Reliable Runbooks: A Guide for Engineers

How to Improve Internal Documentation Agenda

1. Opening & Why Docs Matter

Quick welcome and introduction

One-slide overview: Why good internal docs save time (examples: onboarding, debugging, context sharing)

2. Common Problems in Internal Docs that companies tend to ignore

Live or simulated “bad” examples (unclear runbooks, outdated READMEs, etc.)

Quick discussion: What’s wrong, what’s missing

It would be great to show some workflow diagrams and a PPT.

3. How to Write Better Docs - Best Practices by Hackmamba

Practical tips:

Write for the future you (or the new hire)

Give insights on how Hackmamba solved these problems - Examples are must

Use templates (README, postmortem, design doc)

Add context before instructions

Keep docs discoverable and versioned

5. Tools, Templates & Next Steps

Where to find internal doc templates

Recommended tools (Google Docs, Notion, Confluence, etc.)

Invite them to the Discord server for more in-depth details and doubts.

Agenda

---

Speaker

Blessing Anyebe-Victor - Hack Mamba (Technical Writer)

A technical writer with considerable experience in PostMan, Notion, Gitbook, Google tools (including Google Cloud, Docs, and Analytics), Photoshop, Canva, Markdown (kramdown), Netlify, Swagger, Atlassian (Confluence, JIRA), UIUX Design, Building a static site using (Jekyll, Docurasus, and Gitbook), Community building/management.
I am conversant with writing user manuals, troubleshootin…

Host

Zach Farley - KITT LABS

Zach Farley is an Atlanta native who cofounded KITTLABS co-development studio. A co-working space focused on growing and incubating top-tier software engineers in the fields of Augmented Reality, Virtual Reality, Blockchain, Web development, Mobile development, IoT, and machine learning.
Zach has 7+ years of software engineering experience working with both enterprise and startup compani…

Complete your event RSVP here: https://gdg.community.dev/events/details/google-gdg-atlanta-presents-from-messy-readmes-to-reliable-runbooks-a-guide-for-engineers/.