Get AI summaries of any video or article — Sign up free
Product Documentation Strategy - Kay Miles thumbnail

Product Documentation Strategy - Kay Miles

Write the Docs·
5 min read

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.

TL;DR

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?

Shared templates can align the “look” of documentation, but silos still diverge in how content is structured, published, and maintained. Miles describes software writers optimizing for API reference and in-software context, while hardware writers optimize for printed specs, safety, and compliance. Systems writers then try to support bundles that combine products, but the underlying processes and documentation sets often don’t integrate cleanly—so writers spend more time troubleshooting and patching inconsistencies than producing coherent content for users.

What does “documentation strategy” mean in her framework, beyond writing guidelines?

Miles treats strategy as the decision-making already embedded in good writing: identifying who the users are, why they use the product, what they seek, and when they need documentation. Documentation strategy makes those decisions explicit at the ecosystem level—shifting from a single product mindset to how content is created, organized, and delivered across multiple products and channels.

How do information architecture, content strategy, and content engineering divide responsibilities?

Information architecture designs the blueprint for information spaces—navigation and content types, often linked to website-like structures. Content strategy focuses on content assets and buckets, aligning content organization with user questions (who/what/when/where/why) across contexts. Content engineering then implements the blueprint: choosing CMS and sourcing approaches, defining how content is published, and ensuring delivery mechanisms can support the designed structure.

What user expectation changes does Miles highlight as driving the need for intelligent content?

She emphasizes consistency across devices and contexts in an Internet-of-Things environment—users expect seamless support whether they search from a watch, laptop, or store setting. She also points to Google-like expectations: answers should appear early in results, and systems should anticipate the question before the user finishes typing.

What was the practical failure mode in the CHM-to-web conversion example?

An internal tool converted CHM help files into web-friendly HTML, but over time it became hard to maintain and was adapted to multiple CMS workflows. Writers spent cumulative time—over 2,600 hours—turning already-written content into a deliverable that still didn’t satisfy users. The result was poor navigation and static pages that were effectively invisible: over 1 million live pages existed, and about 800,000 received zero views, indicating findability problems rather than content quality issues.

What decision did Miles’ team make, and why was it strategically significant?

They stopped relying on the legacy conversion tool, removed large volumes of static pages, and redirected effort toward building a new content ecosystem aimed at “content intelligence.” The strategic significance was freeing writers from repetitive, low-value conversion work and replacing a brittle, ad hoc publishing pipeline with a foundation designed for findability and adaptability—so future content can support new delivery formats without rewriting everything.

Review Questions

  1. How does Miles distinguish between aligning documentation “appearance” and aligning documentation “infrastructure”?
  2. In her three-role model, what specific responsibilities belong to information architecture versus content engineering?
  3. What evidence from the CHM-to-static-HTML case suggests the problem was findability rather than writing quality?

Key Points

  1. 1

    Documentation strategy focuses on the end-to-end content ecosystem, not just templates or style rules.

  2. 2

    Siloed documentation processes create inconsistency and force writers into troubleshooting instead of writing.

  3. 3

    Information architecture designs the structure of information spaces (navigation and content types).

  4. 4

    Content strategy organizes content assets and buckets around user needs across contexts.

  5. 5

    Content engineering makes the design real through CMS choices, content sourcing, publishing, and delivery mechanisms.

  6. 6

    User expectations now demand cross-device consistency and Google-like findability, which ad hoc fixes can’t reliably deliver.

  7. 7

    A legacy publishing tool can become a major bottleneck; removing it and rebuilding the ecosystem can restore writer time and improve content visibility.

Highlights

Miles argues that “band-aids above the surface” persist chaos when teams respond to individual documentation complaints without fixing root causes.
She frames documentation strategy as a set of connected roles—information architecture, content strategy, and content engineering—that together create a stable content foundation.
In the CHM-to-web example, writers spent over 2,600 hours while roughly 800,000 static pages received zero views, pointing to findability failures.
Stopping a long-used legacy tool was a high-stakes decision that freed writers to focus on higher-value content work and enabled a shift toward content intelligence.

Topics

Mentioned

  • Kay Miles
  • CHM
  • API
  • MVP
  • SEO
  • CMS
  • IoT