Close

Writing documentation

Writing structured, comprehensible, efficient content... not always that simple

Your product is almost finished. Great, but there is no documentation. Do we have someone who can fill in as a technical writer? Who has time? To explain what's essential and automate where needed. While ensuring a clear structure and unambiguous language, a professional layout, illustrations... Technical writing, how do you go about doing that?

Contact us

Writing documentation

Do you recognize these problems?

We simply don't have the time to write it all down! | Can't we automate this process?

We urgently need to update this but we're still collecting data. Write it myself? Urgh, no thanks!

No one is reading our documents...

How we can help you

How we can help you

API-docs

We look at your API documentation from our techcomm point of view and make it easy to access for your customers and easy to manage for you (docs-as-code).

We optimize your OpenAPI specs together with your developers. We fill the information gaps (getting started, how-to) and make sure form and content (names for example) are consistent throughout your API platform. In doing so, we create accurate reference documents in Markdown or DITA that can easily be updated.

Well-structured API documents also allow you to reuse existing information easily.


Are you looking for a technical writer?

Technical writers @ Flow take care of your technical documentation and everything that comes with it. We boast years of experience in all kinds of fields and with all kinds of technologies, and always want to learn more.

Our technical writers see the whole picture. How can you best manage and pass on knowledge and information? How do you organize your documentation?

It goes without saying that our technical writers have a thorough knowledge of minimalism, structured writing and DITA. And that we, as technical communication specialists, rigorously apply the style guides and best practices from our own field. We are of course also familiar with the tools and systems used in this trade.

Structured authoring

Structured authoring enables efficient, focused and goal-oriented writing. Users of structured documents can quickly find relevant and clear information.

Structured authoring is a way of writing in which you use:

  • “information building blocks” determined by an information model
  • standards, rules and guidelines to structure your text

You can apply structured authoring to all kinds of texts, regardless of the software application that you use. Read more.

Document types

Contact us if you need assistance with writing, organising or structuring any of the following document types:

  • technical: maintenance and repair manual, process description, quick start guide, work instruction, safety manual, standard operating procedures (SOP), reference guide
  • web: web content, intranet
  • business: presentation, policy, business plan, product description, service level agreement, offer
  • training: trainer manual, training plans, e-learning, simulation, training guide, presentation
  • IT: use case, specification, wiki knowledge base, online and onboard help, installation and configuration guide

DITA (Darwin Information Typing Architecture)

DITA is an innovative method and an international OASIS standard for structuring and publishing content. The main idea of DITA is that you write small, structured chunks of information (“topics”) containing text, illustrations, tables and even video, which you manage in a central repository and reuse in various publications and documents (“single sourcing”). You save the topics in a standardized format (XML), which you can maintain and publish using a myriad of tools. DITA topics are easy to maintain, cut down on translation costs and are ideal for omnichannel publishing, for example on a smartphone or tablet. You can use various XML editors to write content in DITA, such as oXygen XML Author, FontoXML, XMetaL Author and Adobe FrameMaker with DITA-FMx.

Document outlines

You haven’t the slightest idea how to start writing that process description? Or does everyone write it in a different way, so there is no consistency? Use Flow’s document outlines. Forget those worries about the layout or structure of your document. Our outlines provide you with a basic structure to work with, so you can focus on writing the content that you need.
Our document outlines are available in several languages and for different types of documents.

A fresh pair of eyes

Documentation is written by experts, but not often for experts. We at Flow are the first real ‘users’ of your documentation or product. That is why our Flow team can ask the right questions:

  • Which information is important for your customer?
  • Which questions will your customer have?

Flow walks the thin line between expert and customer.

International standards

Does your documentation comply with the current norms and laws, like ISO IEC 82079-1:2012 and the machinery legislation?
Do you want to reorganize your documentation to obtain an ISO certification? We analyze your documentation and the requirements. That way you can convert existing documents and structure new documents correctly from the start.

INTERESTED?CONTACT US

Interesting documents

Some references

Our clients