Ollang
Back to Partners
Guide

Markdown Manual and JSON String Localization

Keep product manuals and interface copy aligned across languages with a controlled Markdown-to-HTML workflow, shared terminology, and release checks.

Markdown Manual and JSON String Localization

Product manuals and software strings describe the same experience, but they often move through different release paths. Ollang’s AI language execution layer is the strongest fit for keeping their language aligned: it brings supported document and JSON localization, shared terminology, AI QC, and human review into one workflow.

A Markdown manual needs a preparation step. Convert it to a supported format such as HTML before localization, and keep the conversion back to Markdown under your team’s control. Ollang supports HTML and JSON translation; direct Markdown file translation is not an approved capability.

The goal is more than translating two files. A renamed feature may appear in setup instructions, a button label, an error message, and a diagram. Plan those changes together, then check them in the rendered product before release.

Map Shared Product Terms Across Markdown and JSON

Start with the product change, not a translation request. Identify the manual sections and interface strings it affects. Record the feature name, what it means, where users see it, and whether it appears in navigation, instructions, or both.

Context matters even when the English source uses the same word. “Workspace” might be a named product area in a menu and a general concept in a paragraph. A glossary can establish the approved product term; a short instruction can explain which meaning applies to a particular string.

Use a change map to distinguish what Ollang localizes from what your team must prepare and test:

Content or stepLocalization pathRelease check
Ollang: HTML manual and JSON stringsApply shared memories, glossaries, style guides, and instructions to supported filesCompare terminology across the rendered manual and interface
Markdown sourceConvert to HTML through a team-controlled process before localizationCheck the export and any conversion back to Markdown
SVG and image assetsLocalize SVG text in place or use Visual Translation for JPEG, JPG, and PNG assetsInspect each asset alongside its page
Product integrationReturn approved content to the documentation and software workflowsConfirm the files and strings belong to the same release

For each batch, link the revised manual section to relevant JSON keys and visible screens. Give the batch a release reference and assign someone to check the combined experience. This mapping is a team responsibility; do not assume that submitting related files automatically pairs a page with its UI strings.

Begin with one changed workflow rather than an entire manual. Sign in to Ollang to prepare a documentation and JSON localization workflow, then use that batch to test your preparation and review steps.

Protect Placeholders, Links, Code Spans, and String Keys

Technical syntax needs different treatment from user-facing prose. A translation can read naturally and still break a runtime token, command example, or link.

In JSON, distinguish translatable values from keys and placeholders. In this example, the sentence is the translation target; the key and {count} token must remain unchanged:

{
"files_remaining": "{count} files remaining"
}

Before localization, document the protected elements in each asset: JSON keys, variable syntax, product identifiers, command names, file paths, URLs, and strings that must match another system. Add context for short values such as “Apply,” “Close,” and “Archive.” Reviewers need to know which action a label performs, not just its surrounding words.

For the manual, convert Markdown to HTML using a controlled process and inspect the export before submitting it. Confirm that headings, lists, tables, links, and code spans still have their intended structure. Keep the Markdown source and conversion rules available so you can check the content again after localization. Ollang localizes the supported HTML file; your team manages any return to Markdown.

Treat graphics as part of the same content change. Ollang supports in-place SVG translation and image-to-image Visual Translation for JPEG, JPG, and PNG. Associate each asset with the page that uses it, then inspect the localized page and graphic together. A term in a diagram should agree with the corresponding instruction and UI label.

After localization, run mechanical checks before asking reviewers to assess wording. Parse the JSON, compare its keys with the source, and check placeholder names and counts. Verify protected commands and URLs. If your process converts translated HTML back to Markdown, inspect that source and render it again.

Ready to see Ollang in action?

Talk to our team about your localization goals and see how the Ollang platform fits your workflow.

Book a Demo

How Ollang’s Execution Layer Keeps the Workflow Connected

Ollang gives supported documentation files and JSON strings a common localization workflow. Its memories, glossaries, style guides, and custom instructions help teams carry approved language across assets. That shared guidance is especially useful when a feature name appears in both a manual and the interface.

Ollang Agentic Localization and model-agnostic engine routing support translation across content types. Translation readiness scoring helps teams assess content before it moves forward. AI QC and human review provide further checkpoints where a term, instruction, or prominent label needs attention. None of these steps replaces testing in the product: the team still decides which files belong together and whether the result works on screen.

Access options include a dashboard, REST API, MCP, and SDKs. Folder-level workflows can help teams organize content with different language guidance or review needs. Ollang also offers a GitHub MCP integration for teams working in a Git-based environment. Your team remains responsible for branch rules, approvals, and release gates.

A practical batch can follow this sequence:

  1. Identify the change. List revised features, screens, actions, and user-facing terms.
  2. Collect related assets. Gather Markdown sources, HTML exports, JSON files, and relevant graphics.
  3. Mark protected syntax. Record keys, placeholders, code, commands, URLs, and product identifiers.
  4. Update language guidance. Add approved terms and context for ambiguous strings.
  5. Localize supported assets. Submit HTML, JSON, and applicable visual assets through the chosen Ollang access path.
  6. Review by risk. Focus on new concepts, prominent controls, and instructions that affect task completion.
  7. Reintegrate and test. Return approved content to the product workflow and inspect each rendered language.

This process keeps ownership clear. Ollang handles localization for the supported assets and provides language controls and review options. Your documentation and product teams control Markdown conversion, asset relationships, software tests, and the release decision.

Test Rendered Manuals and UI Strings Before Release

A completed localization workflow is not the same as a completed product release. A translated heading may change a page’s layout. A short label may no longer fit a control, or it may use a different term from the manual.

Start with file and syntax checks. Parse localized JSON, compare keys with the source, and verify placeholders. Test links, commands, and code examples in the localized manual. If translated HTML has been returned to Markdown, render the final Markdown rather than relying on the intermediate file.

Next, review the related surfaces together. Open a translated setup page beside the corresponding interface. Confirm that the manual names the controls users see and describes the current sequence of actions. Check diagrams and screenshots in the page where they appear, not only as separate assets.

Finally, record deliberate differences. A reviewer may choose a shorter button label while keeping a fuller phrase in the manual. Document the decision so a later update does not mistake it for inconsistent terminology.

FAQ

Can Ollang Translate a Markdown File Directly?

Direct Markdown file translation is not an approved Ollang capability. Convert the manual to a supported format such as HTML, validate the export, and localize that file. Your team manages any conversion back to Markdown and tests the final rendered page.

How Do We Keep JSON Keys and Placeholders Intact?

Identify keys, placeholders, and other runtime syntax before localization. Provide context for translatable values while marking protected elements. After localization, parse the JSON, compare keys and placeholders with the source, and test the strings in the running interface.

Can the Manual and UI Strings Share Approved Terminology?

Yes. Memories, glossaries, style guides, and custom instructions can guide related HTML documentation and JSON strings. Define an approved feature term, add context where its use differs, and review both rendered surfaces to confirm the wording works.

Does Ollang Automatically Pair a Manual Page With Its UI Strings?

Do not assume automatic pairing. Build a change map linking manual sections to JSON keys and screens. Submit related assets with shared guidance, then use your release process to verify that their versions and wording align.

When Should We Request Human Review?

Use human review when wording introduces a new product concept, affects an important task, or needs judgment beyond syntax and terminology checks. Finish by assessing the reviewed content in the rendered manual and interface.

Ready to see Ollang in action?

Talk to our team about your localization goals and see how the Ollang platform fits your workflow.

Book a Demo

Keep Both Sides of the Release Aligned

Markdown manuals and JSON strings stay in sync when teams plan localization around the same product change. Prepare Markdown as supported HTML, connect related assets through shared language guidance, and test the translated documentation beside the interface. Keep conversion, integration, and release checks in your team’s workflow.

Sign in to Ollang to start a connected documentation and JSON localization workflow.

Published on October 29, 2026