Hardware Podcasts

28: A Lot of Wish Fulfillment

Embedded.fm · 20 Nov 2013 · 48m

What this episode covers

Laura Lemay, a technical writer and author of the 'Teach Yourself ... in 21 Days' series (including HTML and Java), discusses the evolution of technical writing, the challenges of documenting APIs, and the importance of clear code. She explains how developer-focused technical writers must understand source code to effectively interview engineers and push back on inconsistent APIs. Lemay also shares her experience with NaNoWriMo, her struggles with perfectionism in science fiction writing, and the value of Edward Tufte’s work on information design for engineers.

Most relevant to

established companies

Topics

Mentioned

Companies
O'Reilly, Stack Overflow
Products
Teach Yourself Java in 21 Days, Envisioning Information, Diamond Age, The Knife of Never Letting Go, Head First Java
Also
Edward Tufte, Neal Stephenson, Patrick Ness, Kathy Sierra, NaNoWriMo

Related episodes from other shows

Other shows on the same ground, closest first.

  • Being an Engineer · 48m

    S4E42 Pam Hurley | Technical Writing, Presentations, & Communications

    Pam Hurley, founder of Hurley Write, Inc., explains that technical writing is a critical career lever for engineers, arguing that poor documentation stifles promotions and business opportunities regardless of technical skill. She emphasizes that writing is 'thinking on paper,' urging engineers to prioritize clear logic and audience-centric strategy over perfect grammar, which tools like Grammarly can fix. Hurley provides specific advice on avoiding common pitfalls in proposals and presentations, such as burying the lead or cramming slides with information, and advocates for starting with the end goal to reverse-engineer effective communication.

    Careers & educationIndustrial & consumer product design
    10 chapters

  • Oxide and Friends · 1h 40m

    Technical Blogging

    Bryan Cantrill and Adam Leventhal of Oxide Computer Company discuss the history and practice of technical blogging with authors Piotr Sarna and Cynthia Dunlop, who are writing the book "Writing for Developers." The conversation traces the evolution of blogging from Sun Microsystems' blogs.sun.com initiative led by Tim Bray and Will Snow to modern static site generators, highlighting how long-form writing clarifies thinking and builds community. They analyze specific influential blog posts, such as Leventhal's analysis of AWS Outposts and Cantrill's controversial piece on pronouns, to illustrate the power and risks of public technical discourse.

    Creator businessAI & machine learning
    9 chapters

  • Manufacturing Happy Hour · 37m

    Marketing to a Technical Audience with Wendy Covey

    Wendy Covey, CEO and founder of TREW Marketing, explains how middle-market engineering companies can effectively market to technical buyers by focusing on the engineer specifier rather than just the C-suite. She details the importance of creating 'pillar pages' and evergreen content, citing a case study where a single webinar on dynamometers generated 1,500 leads annually for WTI. Covey also discusses the necessity of pairing subject matter experts with skilled writers to balance technical accuracy with engaging storytelling, and introduces her new digital training course, Content Writing Engineered.

    Marketing & brandValidation & product-market fit
    10 chapters

  • The Pragmatic Embedded Podcast · 58m

    Living Documentation with Philip Markgraf

    Philip Markgraf, an experienced software developer and technical leader, explains how he transformed a medical ventilator team’s engineering culture by using living documentation derived from test-driven development. He details the process of using unit tests as software design descriptions and integration tests as software requirements specifications (SRS), eliminating the need for static Word documents. Markgraf argues that this approach, combined with ensemble programming, significantly reduces bugs, accelerates feedback loops, and improves overall product quality in regulated industries.

    Embedded firmwareQuality & yield
    10 chapters

  • The Electromaker Show · 1h 08m

    Documentation as Code: A chat with Alasdair Allan from Raspberry Pi

    Alasdair Allan, Head of Documentation at Raspberry Pi, explains the 'Documentation as Code' philosophy used for the RP2040 and Pico W, emphasizing narrative and accessibility. He discusses the challenges of documenting custom ASICs, the pricing strategy behind the $4 Pico, and the importance of bridging the gap between expert engineers and generalist makers. Allan also shares personal project ideas, including a Wi-Fi mesh cannon and a personal time zone clock, while critiquing the friction in modern smart home technology.

    Embedded firmwareMicrocontrollers & dev platforms
    6 chapters

The summary, chapters and topics are generated from the episode’s audio by this directory, not written by Embedded.fm. The episode itself belongs to its publisher.