196: Documentation as Performance with Aisha Blake
- Author
- Mandy Moore
- Published
- Wed 19 Aug 2020
- Episode Link
- https://www.greaterthancode.com/documentation-as-performance
02:26 - Aisha’s Superpower: Proofreading
04:05 - Documentation
- “The Code Documents Itself”
- Context / Entry Points
- Documentation as a Narrative
- The Value of Documentation
07:54 - Forms of Documentation Worth Investing In
- Onboarding
- Commit Messages
- Pull Requests
10:34 - Architecture and Stories
- Commit Messages
- References
- User Stories
17:17 - Telling Stories Through Documentation
- Documentation as Performance
- < title of conf >
- Tail Call Optimization: The Musical!! by Anjana Vakil & Natalia Margolis
23:37 - Defining Documentation
26:17 - Making Documentation Accessible & Approachable
- Requires Empathy
- Collaboration
- Constructing Shared Common Ground
33:33 - Giving Constructive Feedback
- Feedback Requires Consent
- Interviewing for Interpersonal Skills That Are Required to Give Good Feedback
- “Tell me a story…” / Roleplaying
- Give Feedback Fearlessly – Aisha Blake
44:37 - self.conference: Focusing on Human Aspects in Technology
48:49 - Technology is NOT Neutral
- Moral Responsibility
- The Things We Build Have Impact
- Inclusion and Exclusion
This episode was brought to you by @therubyrep of DevReps, LLC. To pledge your support and to join our awesome Slack community, visit patreon.com/greaterthancode
To make a one-time donation so that we can continue to bring you more content and transcripts like this, please do so at paypal.me/devreps. You will also get an invitation to our Slack community this way as well.
Special Guest: Aisha Blake.
Sponsored By:
- Honeybadger: Let's face it, your code is going to have errors, even code written by a kick-ass developer such as yourself. When bad things happen, it's nice to know that Honeybadger has your back.
Honeybadger makes you a DevOps hero by combining error monitoring, uptime monitoring, and chron monitoring into a single, easy to use the platform, all for way less than you're probably paying now.
Honeybadger monitors and sends error alerts in real-time with all the context needed to see what's causing the error and where it's hiding in your code so you can quickly fix it and get on with your day.
The included uptime and chron monitoring also let you know when your external services are having issues or your background jobs go AWOL or silently fail.
Go to Honeybadger.io and discover how Starr, Josh, and Ben created a 100% bootstrapped monitoring solution. Why is this important? Self-funding means they only answer to you, the developer, rather than a venture capital overlord.
Greater Than Code listeners get 30% off for 6 months. Simply mention Greater Than Code when signing up and they'll apply the discount to your account; no credit card required.
- strongDM: Today's show is sponsored by strongDM.
Managing your remote team as they work from home? Managing a gazillion SSH keys, database passwords, and Kubernetes certs?
Meet strongDM. Manage and audit access to servers, databases, and Kubernetes clusters, no matter where your employees are.
With strongDM, easily extend your identity provider to manage infrastructure access. Automate onboarding, offboarding, and moving people within roles. Grant temporary access that automatically expires to on-call teams.
Admins get full auditability into anything anyone does: when they connect, what queries they run, what commands are typed. It's full visibility into everything. For SSH, RDP, and Kubernetes, that means video replays. For databases, it's a single unified query log across all database management systems.
strongDM is used by companies like Hearst, Peloton, Betterment, Greenhouse, and SoFi to manage access. It's more control and less hassle.
strongDM. Manage and audit remote access to infrastructure.
Start your free 14-day trial today at strongdm.com/SDT
- Virtual Genius: Collaboration between different disciplines in your organization can be difficult, and finding clarity and alignment on both the right problem to solve and the right solution design is even more so. We each approach improvement from our own (limited) perspective, without taking into account the whole story. How is that effective?
Paul Rayner's EventStorming Facilitation Virtual Workshop is a multi-day online event that promotes collaboration between different disciplines in order to solve business problems in the most effective way.
This virtual workshop with Paul consists of 4 sessions on Sep 28-Oct 1 from 9am-Noon (CDT) each day. To register and get 20% off your ticket, visit virtualgenious.com/events and use the code VGGTC.
In this highly hands-on and interactive virtual workshop you'll learn advanced EventStorming facilitation skills spanning from large scale business discovery to collaborative solution design at the team level.
Once again to get 20% off your ticket, visit virtualgenious.com/events and use the code VGGTC.
Promo Code: VGGTC
