--- title: 'Documentation: writing, translation and publishing | Karbonic' canonical: https://www.karbonic.net/documentation-technique-en.html meta-description: Reuse Word documents, write, unify and translate content. Structured sources support updates and publication for web, PDF or print. description: Reuse Word documents, write, unify and translate content. Structured sources support updates and publication for web, PDF or print. language: en og:title: 'Documentation: writing, translation and publishing | Karbonic' og:description: Reuse Word documents, write, unify and translate content. Structured sources support updates and publication for web, PDF or print. og:image: https://www.karbonic.net/assets/service-writing-v9.webp og:locale: en_GB og:type: website og:url: https://www.karbonic.net/documentation-technique-en.html twitter:card: summary_large_image twitter:title: 'Documentation: writing, translation and publishing | Karbonic' twitter:description: Reuse Word documents, write, unify and translate content. Structured sources support updates and publication for web, PDF or print. twitter:image: https://www.karbonic.net/assets/service-writing-v9.webp theme-color: '#17212c' --- Source: https://www.karbonic.net/documentation-technique-en.html Technical documentation # Documentation: writing, translation and publishing. Reuse Word documents, write, unify and translate content. Structured sources support updates and publication for web, PDF or print. ![Technical writing workspace with reference parts.](https://www.karbonic.net/assets/service-writing-v9.webp) ## Documents that remain useful and easy to update Your manuals were written at different times, by several people, across multiple files or languages. You need to publish quickly without manually reworking every version. Karbonic works on content, structure and production, drawing on around twenty years of technical communication. An existing document can be corrected and unified. A product range can also be organised around shared content, variants and translations. Work is sized according to what you actually need to publish and maintain. ## A manual published for web and print **Already delivered.** A machine manual was prepared for web consultation and printed publication. Content, illustrations and translations are organised so that updates can be reflected in the affected outputs. **Worked example: three variants.** Three equipment variants share maintenance operations but have different settings. The common procedure is maintained in one place; values and conditions specific to each variant remain separate. Each manual is then reviewed in context. ### Formats delivered - **Publications:** web, PDF and files prepared for printing, according to agreed outputs. - **Sources:** reuse of Word, structured DITA or DocBook authoring; HTML according to the publishing workflow. - **With delivery:** languages, illustrations, sources handed over and update rules defined in the engagement. Conversions and layout are checked on a sample. Not all formats are interchangeable without adaptation. ## My documents are in Word: can they be reused? Yes. Useful files are identified first: reference version, appendices, original images, tables and available translations. Styles, heading levels, captions and cross-references are examined. Outstanding corrections and comments are taken into account. Reworking can remain in Word with harmonised templates and styles, or prepare a move to another publishing workflow. The choice depends on updates, variants and the number of people involved. A representative sample checks tables, illustrations and particular elements before processing the whole. An import alone guarantees neither quality nor consistency in the resulting document. ## How are inconsistent documents unified and rewritten? Documents are compared to identify repetition, contradictions and terminology differences. A common structure and writing rules are defined: component names, units, instructions, step presentation and level of detail. Overlong or ambiguous wording is rewritten. Outdated information is removed after validation; missing information is flagged. The same expression can then identify the same component in the manual, interface and training material. Substantive changes remain distinct from presentation corrections. More fluent text must retain the product’s facts, values and conditions of use. ## What does structured authoring mean? Content is organised by its role: a procedure, explanation, technical reference or warning. This organisation is separate from page layout. An instruction is therefore not identified simply because it appears in bold. Content units can be prepared for reuse. A procedure shared by several models can be maintained in one place and included in the relevant publications. Variants remain explicitly identified to avoid presenting an instruction to the wrong reader. The method can start modestly with consistent styles and clear sections. It does not immediately require a full migration to XML. ## DITA, DocBook, HTML or Word: which should you choose? **DITA** is an XML architecture organised around reusable topics, including procedures, concepts and references. Assemblies called maps compose different publications from those topics. It is worth examining when several products or audiences share a substantial documentation base. **DocBook** is an XML vocabulary used particularly for hardware and software documentation. Its structure and transformation tools organise publications and produce web or paginated outputs. It may suit a workflow already built around books, chapters or articles. **Word and HTML** may suit other uses. The choice is based on documents, expected reuse, authors’ skills and existing tools. Formats exchanged with partners and migration conditions also matter. Conversions, particular elements and expected outputs are tested on a sample. A format name guarantees neither automatic migration nor complete compatibility with every application. ## How are translations organised? A source version is identified, with reference terminology and names that must remain unchanged. Shared content, variants and modified passages are identified to prepare language work. Existing translations can be examined and reused when they still match the content. Depending on the project, translation tools and AI assist production. Terms, values, references and instructions are reviewed: a plausible translation can still be technically wrong. Languages, people responsible for approval and the expected level of review are defined before starting. Delivered versions remain linked to their source. ## Can several documents be produced from one base? Publishing can provide a complete manual, a targeted guide, online help or maintenance instructions. Shared content is separated from elements specific to a product, option or audience. Example: three equipment variants share maintenance operations but have different settings. Shared material can be maintained together, with settings assigned to the relevant variants. Each output must be checked in context. Templates, links, images, tables and page breaks are checked in delivered formats. A common source helps consistency; it does not remove the need to review the published result. [See a manual produced for web and printFR](https://www.karbonic.net/journal-manuels-multiformats.html) ## What is the role of AI and HTML Editor? Karbonic’s own tools and reusable working instructions guide preparation, rewriting and checks. AI can accelerate repetitive operations; product information and editorial decisions are still verified. HTML Editor is developed by Karbonic for structured authoring and publishing, with a controllable workflow. It can be fully controlled through AI. Functions and formats required for your project are checked in practice before migration. [Explore HTML Editor](https://www.karbonic.net/html-editor-en.html) ## What do you receive and how is the work priced? The proposal specifies content, languages, delivery formats, sources handed over and expected approvals. It distinguishes initial reorganisation from production of subsequent versions. Page count does not explain everything: source condition, missing illustrations, inconsistencies, variants and languages affect the work. A first package demonstrates the result and clarifies subsequent operations. One or two representative documents and the list of desired publications are enough to begin the analysis. Original files and available images help avoid unnecessary reconstruction. ## Format references [OASIS: topics and reuse in DITA](https://docs.oasis-open.org/dita/dita/v1.3/errata02/os/complete/part1-base/archSpec/base/topicdefined.html) · [DocBook: documentation and publishing tools](https://docbook.org/) A concrete starting point ## Let's discuss what you want to improve. Describe the difficulty. Options and the work required will be discussed with you. [Let's discuss your situationFR](https://www.karbonic.net/contact.html) [Work, budget and schedule](https://www.karbonic.net/accompagnement-en.html)