Cisco · Structured Content · Localization

Reducing Translation Work Across a Dozen Products and 50+ Languages

Roughly a dozen related phone models shared substantial content but were not identical. Reusable content modules kept common information consistent across products and limited translation churn across more than 50 languages.

Context

The Cisco IP Phone documentation suite covered roughly a dozen phone models. They shared many features, tasks, and supporting explanations, but they were not identical. The customer documentation for those models was published in more than 50 languages.

Challenge

An edit to the shared English source did not end with the writer. It could require translators to update the affected content in more than 50 languages, language reviewers to check the results, publishing teams to regenerate the outputs, and release teams to make sure the correct files shipped with each product. Repeating the same change across separate documentation sets for every phone would multiply that downstream work and give common instructions more opportunities to drift apart.

The models were not identical, so the shared source still had to preserve real product differences. Too little reuse created avoidable translation and release work. Too much could give customers instructions for features their phones did not have.

The team needed clear rules for what could remain common, which differences mattered to readers, and when an English change required new translation work.

Designing for Reuse and Translation

I helped design the reuse strategy around shared structured content modules. Content that meant the same thing across products lived once and was included in multiple books instead of being copied into parallel sources. Variables and conditional content handled smaller differences, while product-specific material remained separate when its meaning or maintenance path was genuinely different.

Shared content also required change control. A writer could not make an ad hoc change to a shared chunk that would silently affect every book using it. Proposed changes were reviewed, voted on, and approved before the shared source was updated and sent for translation.

Localization became part of the architecture rather than a downstream cleanup step. Because each shared content module had one maintained English source, the team could identify exactly what changed, send only that material for retranslation, and let the translated update flow automatically into every book that reused it. No one had to copy the same change through parallel books. When a change applied to only one model or feature, stable translated material elsewhere in the family did not need to move with it.

The documentation itself ranged from quick-start and user documentation to administrator documentation and online help. That variety made the reuse decisions consequential. A variable that worked in a short label might not be the right answer for a procedure, and a shared procedure remained useful only while the underlying task stayed the same.

Outcome

The suite supported roughly a dozen related phone models without maintaining a complete duplicate source set for each one. Reuse reduced content drift and limited unnecessary changes to material already translated into more than 50 languages.

At that scale, the reuse architecture controlled consistency, localization cost, review effort, and release work across the entire documentation suite.

Evidence and Technical Detail

Structured FrameMaker, reusable source, variables, conditional content, product-specific exceptions, multilingual publishing, and coordinated localization supported the suite. The architecture had to account for more than 50 languages, including text expansion and the right-to-left, complex-script, and CJK behavior addressed by the wider publishing system.