Product Documentation Strategy - Kay Miles
Based on Write the Docs's video on YouTube. If you like this content, support the original creators by watching, liking and subscribing to their content.
Documentation strategy focuses on the end-to-end content ecosystem, not just templates or style rules.
Briefing
Product documentation strategy is the missing layer that turns fragmented, product-by-product documentation into a consistent, intelligent content system—so users can find answers reliably across devices and contexts. Kay Miles, an information architect at National Instruments, argues that many technical writing organizations fall into “band-aids above the surface”: writers patch individual complaints without fixing the underlying information and content infrastructure. The result is escalating inconsistency, writer burnout, and content that can’t keep up with modern expectations for seamless, Google-like answers.
Miles describes a documentation ecosystem at National Instruments where multiple teams produce technical documentation for modular software and hardware products, bundled into “systems.” While a shared umbrella—style guides, templates, process documentation, and a centralized wiki—helps keep outputs aligned visually, long-running differences in how teams build and publish content have created silos. Software writers focus on API reference and contextual information inside software; hardware writers prioritize printed documentation, specifications, and safety/compliance. Systems writers, tasked with supporting bundles that combine products, often inherit siloed processes that “don’t play nicely together,” pushing writers toward troubleshooting and technical work rather than writing.
To address this, Miles reframes “strategy” as a practical discipline already present in good writing: deciding who the users are, what they need, and when they need it. Documentation strategy makes those decisions explicit and shifts attention from a single product mindset to the entire content creation ecosystem. She breaks the work into three roles that function like a pipeline: information architecture (designing the structure of information spaces—navigation, content types, and where content belongs), content strategy (designing content assets and buckets to answer user needs across contexts), and content engineering (building the mechanisms—CMS, sourcing, publishing, and delivery—that make the design real).
The core problem, Miles says, is that user expectations have changed faster than internal infrastructure. In an Internet-of-Things world, users expect consistent answers whether they search from a watch, a laptop, or a store kiosk—without caring which internal team wrote what. They also expect search behavior shaped by Google: answers should appear early in results, and systems should anticipate questions. When content isn’t structured and connected enough, teams resort to ad hoc fixes that preserve chaos.
Miles offers a concrete example from her own experience: a legacy internal tool that converted CHM help files into static HTML for the web. Over time, the tool became an “orphaned” maintenance burden passed between teams, forcing writers to spend over 2,600 cumulative hours wrestling with finicky conversions. Meanwhile, more than 1 million static HTML pages existed, with roughly 800,000 receiving zero views—suggesting that even accurate content wasn’t findable. The organization made a difficult decision to stop relying on the tool, remove large volumes of dead pages, and redirect effort toward a new content ecosystem aimed at “content intelligence.”
The takeaway is not that intelligent content is easy, but that it’s necessary: investing in information architecture, content strategy, and content engineering creates a stable foundation where writers can thrive and content can adapt to new technologies without rewriting everything. Miles closes by recommending books on content modeling, information architecture, intelligent content, and information experience—positioning documentation strategy as a long-term infrastructure project rather than a set of templates.
Cornell Notes
Kay Miles argues that documentation strategy is essential for turning siloed, product-by-product documentation into a consistent, findable, and adaptable content ecosystem. She frames the work as three connected roles: information architecture (designing information spaces and content types), content strategy (organizing content assets and buckets around user needs), and content engineering (building CMS and publishing/delivery systems that make the design real). Without this infrastructure, teams patch individual complaints, creating inconsistency and wasting writer time. A legacy CHM-to-static-HTML conversion tool became a major bottleneck, with writers spending thousands of hours and hundreds of thousands of pages receiving zero views—prompting a shift toward “content intelligence.”
Why does Miles say documentation silos create problems even when teams share a common style guide and templates?
What does “documentation strategy” mean in her framework, beyond writing guidelines?
How do information architecture, content strategy, and content engineering divide responsibilities?
What user expectation changes does Miles highlight as driving the need for intelligent content?
What was the practical failure mode in the CHM-to-web conversion example?
What decision did Miles’ team make, and why was it strategically significant?
Review Questions
- How does Miles distinguish between aligning documentation “appearance” and aligning documentation “infrastructure”?
- In her three-role model, what specific responsibilities belong to information architecture versus content engineering?
- What evidence from the CHM-to-static-HTML case suggests the problem was findability rather than writing quality?
Key Points
- 1
Documentation strategy focuses on the end-to-end content ecosystem, not just templates or style rules.
- 2
Siloed documentation processes create inconsistency and force writers into troubleshooting instead of writing.
- 3
Information architecture designs the structure of information spaces (navigation and content types).
- 4
Content strategy organizes content assets and buckets around user needs across contexts.
- 5
Content engineering makes the design real through CMS choices, content sourcing, publishing, and delivery mechanisms.
- 6
User expectations now demand cross-device consistency and Google-like findability, which ad hoc fixes can’t reliably deliver.
- 7
A legacy publishing tool can become a major bottleneck; removing it and rebuilding the ecosystem can restore writer time and improve content visibility.