From Messy READMEs to Reliable Runbooks: A Guide for Engineers

GDG Atlanta

How to Improve Internal Documentation Agenda1. Opening & Why Docs MatterQuick welcome and introductionOne-slide overview...

Jul 3, 10:00 – 11:30 PM (UTC)

44 RSVP'd

Key Themes

CloudCommunity BuildingDataDesign

About this event

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.

Speaker

  • Blessing Anyebe-Victor

    Hack Mamba

    Technical Writer

Host

  • Zach Farley

    KITT LABS

Organizers

  • Jessica Rudd

    Mailchimp

    Senior Data Engineer

  • Cinamon White

    TechKnow

    Founder

  • Zach Farley

    KITT LABS Inc

    Organizer

  • Kate Hargrove

    66degrees

    Organizer

  • Soumya Sinha

    Lead Organizer

Contact Us