Services

DITA XML

I join your DITA project and work with your editorial team from day one.

Freelance and project-based, on site or remote, with the XML tools your organization already uses. Billed at an hourly rate.

Sentences I hear in DITA projects

If one of them sounds familiar, one of the four services below fits.

  • “The delivery date is fixed, and the team is missing someone who already knows DITA.”
  • “We moved to DITA, and we still maintain a lot of content twice.”
  • “The migration has been decided, but nobody has time to prepare it.”
  • “Nobody knows any more which condition applies in which output.”
  • “Our safety messages have to match the risk assessment in every variant.”

1 · 2 · 3 · 4

What I deliver in your DITA project

Each service starts with a small, clearly defined first step. You then decide whether and how to continue.

1 Patterns M1 · M8

Extra capacity in your editorial team

For teams that already work in DITA and need an experienced person for a delivery, a change in a standard or a vacant position.

Approach

I join your editorial team for the duration of the project and work with any XML tool in your environment: the editor, the content management system and the publishing chain, as they are set up at your company. I write and revise concept, task and reference topics, maintain maps, and apply reuse through conrefs and keys and variants through conditional attributes, following your style guide.

I need to learn your product and your rules, not DITA. That saves the weeks a new team member without DITA experience would need.

Result

  • topics and maps ready for review in your system
  • a list of what I notice about structure and reuse; you decide what is done with it
  • a short handover at the end: what is finished, what is open and where everything is

Limit

Your rules apply. I do not question your style guide unless you ask me to.

First step: a short conversation about product, tools and deadline. After that, I can usually start without a long onboarding phase.

2 Pattern M7

Moving to DITA

For editorial teams moving to DITA from Word, FrameMaker or another content management system.

Approach

A move is the best opportunity to create structure, and the most expensive one if old chapters are simply copied into new files. I take stock of the existing content, break chapters down into topics, define topic types, metadata, terminology and the rules for reuse and variants, and migrate one manual as a pilot. After that, your team migrates the rest, or I do it together with your team.

Result

  • a content model with topic types, metadata and reuse rules
  • migration rules and a migrated pilot manual as a template
  • a list of the content that should be merged, deleted or rewritten

The structure behind it is described in service C: Structure before it gets expensive.

Limit

I do not select or introduce a content management system. I do not program conversion scripts, XSLT or plug-ins for the DITA Open Toolkit; the technical implementation stays with your IT or your system vendor.

First step: the pilot migration of one manual. It shows what your content looks like in DITA and how much work the rest will take.

3 Patterns M6 · M7

Structure check of your DITA content

For teams that have worked in DITA for some time and find that reuse and variants have become hard to follow.

Approach

I review your maps, topic types, conrefs, keys, conditions and metadata, and I talk to the people who work with them every day. Typical findings are chains of reuse that nobody can trace any more, topics maintained twice, tasks that are really concepts, and conditions that no longer apply in any output.

If an AI assistant is to answer from your content, I also check whether your topics and metadata can carry it. This is conceptual work; connecting the assistant is not part of it.

Result

  • a written report with examples from your own content
  • measures sorted by effect and effort, for the system you already have

Limit

I do not replace your tool, and I do not build specializations or your own DTDs.

First step: the structure check of one map, fixed period, billed by the hour.

4 Patterns M4 · M6

Safety messages and evidence in DITA

For manufacturers in regulated industries whose safety messages come from the risk assessment and have to show it.

Approach

In DITA, safety messages can be kept as separate, reusable elements. I structure them in line with IEC/IEEE 82079-1, link each message to the hazard in the risk assessment and use metadata to define where it has to appear in which variant. That way it stays traceable why a message is there, and a change in the risk assessment reaches every output.

Result

  • reusable safety messages with a consistent structure and terminology
  • a mapping from hazard to safety message and its place in the user information

Aligning the risk assessment and the manual is described in service B: One installation, one truth.

Limit

Your safety engineers decide what is safe, and the risk assessment stays with the manufacturer's experts. A safety message never replaces a protective measure; responsibility for conformity stays with the manufacturer and the competent bodies.

First step: aligning the safety messages of one manual with its risk assessment.

How I work in your team

  • With your tools. I work with any XML tool in your company's environment.
  • By your style guide. Your rules, templates and approval paths apply. I note what I notice; you decide what is done with it.
  • In the team, not beside it. I take part in your meetings, report the way you are used to and work at the interfaces with development, quality and regulatory affairs.
  • Project-based. I join for one project or a fixed period, on site or remote, and bill at an hourly rate.
  • No lock-in. Everything is created in your system and belongs to you. At the end, I hand over a short status, so nobody has to search.
  • With safety and evidence in mind. I know the requirements for user information in regulated industries and make sure structure and evidence fit together.

Terms & contact

How we start

Freelance and project-based, for organizations in every country. You work with me directly.

Hourly rate

Estimate after reviewing your documents

I bill at an hourly rate, which I tell you in our first conversation. After reviewing your documents, I estimate the effort and give you a date. We exchange documents once your non-disclosure agreement is signed.

Switzerland

Employment preferred

For organizations in Switzerland, I prefer to work in fixed-term or permanent employment. Project-based freelance work is possible as well.

Based in the Rhine Valley — close to St. Gallen, Vorarlberg and Lake Constance.