Sarah Maddox Article Review: Internal vs. External Documentation
About this episode
Welcome to episode 108 of the Technical Writing Success podcast from the Curt Robbins & Associates Technical Writing Agency.
This podcast is targeted at IT professionals, technical writers, and documentation specialists. Subscribe today to never miss a single daily episode!
Today’s episode dives into an article from Google alum Sarah Maddox in Sydney, Australia entitled "Writing Internal vs External Docs: What's the Difference?" (link below).
Hosts Daphne and Fred share their spirited analysis of this educational article from Maddox about the difference between internal and external documentation, including the many ways in which the two are similar and require similar approaches by technical writers. They describe strategies and approaches that should be embraced by documentation specialists to best reach these two audiences and how an intense focus on one's audience is the overall takeaway, regardless of whether that audience is internal or external.
They also discuss Doc Sprints and Doc Fixits, two helpful approaches employed by Maddox. In addition, they describe the Docs as Code approach embraced by Maddox and how documentation should be woven into software development from the beginning of a project.
The Curt Robbins & Associates Technical Writing Agency is currently taking on new clients. We enjoy helping companies with their documentation and communications strategy and implementation. Contact us to learn about our reasonable rates and fast turnaround.
>> Read the Maddox article: https://tinyurl.com/yc25wrmx
>> Read the Curt Robbins article "Leading CMS Tools for Technical Writers Compared": https://tinyurl.com/hdhb8cjz
>> Read the Robbins article "XML vs. DITA: Comparison for Technical Writers": https://tinyurl.com/ycke9hpp
>> Read the Robbins article "Tech Writers: Embrace Structured Content": https://tinyurl.com/4z8fzu6u
>> Read the Robbins article "Accessibility & Inclusivity in Technical Writing": https://tinyurl.com/4ptn2vvu
>> Subscribe to the AI for Technical Writers podcast: https://tinyurl.com/mppehxtn
Get every episode summarized
Each time Technical Writing Success publishes, we email you a written briefing from the transcript — the topics, who appeared, and any specific claims, with the ad reads skipped.
Email me new episodesFree for 3 shows. No card needed.
Hosts & guests
No transcript yet
This episode has not been transcribed. Request it and it moves to the front of the queue.
More episodes
More from Technical Writing Success
A Fond Farewell—and Where to Find Us Next
Technical Writing Success
Context Engineering: The AI Skill That Outlasts Any Job Title
Technical Writing Success
Does llms.txt Actually Work? An Honest Look for Technical Writers
Technical Writing Success
What Technical Writers Should Automate First (A Practical Playbook)
Technical Writing Success