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 step | Localization path | Release check |
|---|---|---|
| Ollang: HTML manual and JSON strings | Apply shared memories, glossaries, style guides, and instructions to supported files | Compare terminology across the rendered manual and interface |
| Markdown source | Convert to HTML through a team-controlled process before localization | Check the export and any conversion back to Markdown |
| SVG and image assets | Localize SVG text in place or use Visual Translation for JPEG, JPG, and PNG assets | Inspect each asset alongside its page |
| Product integration | Return approved content to the documentation and software workflows | Confirm 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.
