latest news

01.02.2013

DocDev is translating and writing user and technical documentation for Finnova.

Read more ...

01.04.2012

DocDev is writing internal technical documentation for the SCC SENT team of BNP Paribas Fortis.

Read more ...

01.06.2011

DocDev starts (re)writing and translating the DLW website in French and English.

Read more ...

03.01.2011

DocDev's contract at Belgacom is extended by 3 months.

Read more ...

docdev logo

For all your e-doc solutions.

technical communication

- "How do you do that again?"

- "Didn't it come with a user manual?"

- "I think it did."

- "Let me see."

- "Press F1, I believe."

- "O my God! Do they really think I have the time to read 500 pages?!?"


Sounds familiar?

 

Why you are better off with a technical writer


Hiring a technical writer will bring the efficiency of your documentation to unknown hights.


In a world of I-need-it-yesterday deadlines, companies are facing an increasing need to streamline their approach to both product and service documentation. This is particularly true in technologiy companies, where product upgrades, global presence and complex markering strategies need to be supported by rapidly-generated documentation.

However, in many companies it is still customary to write adhoc documents making information not readily available on time or even causing information to get lost.

That is when the technical writer comes in. She is the person who manages all information flows, who updates the documentation or manages a team of specialists to get it done. She is entrenched in a culture of structuring , sharing and re-using information. She is your first user who can enlighten the user about what she needs to know at a particular moment in time.

By creating communication building blocks that are used and re-used when needed (chunks of text, chapters, images, multimedia), technical writers create ready-made context relevant pieces of information so that users have all the relevant information at their fingertips, if they need it and when they need it.

By creating communication building blocks that are used and re-used when needed (chunks of text, chapters, images, multimedia), technical writers create ready-made context relevant pieces of information so that users have all the relevant information at their fingertips, if they need it and when they need it.

A technical writer is ideally a communicator who has a skilled knowledge of engineering, writing, linguistics, translation, editing and publishing. She is a valuable asset who has to be able to make sound judgements about the content, objectives and quality of the documentation. Simple checks in area of linguistic accurary, document structure and presentation ensure that the documents are enjoyable to read.

So, hiring a technical writer will bring the efficiency of your documentation to unknown hights.

 

Single-sourcing


To boost the efficiency of your documentation, professional technical writer adhere to the principles of single-sourcing. Single-sourcing means that different media are generated from one and the same source text.


Modern content authoring tools allow the writer for instance to generate from a single source text both the online help of a user manual that can be viewed in a browser and that has its own specific search tools, and the pdf variant that can be printed and also has its specific search tools.

Another benefit of single-sourcing is that it is possible to deliver audience-targeted documents. It would be possible for instance to generate from a single source text a user manual for novice users, one for intermediate users and one for expert users, each with their specific content. Possibilities galore.

User Benefits

  • optimisation of the efficiency of the documentation per medium type (online, paper, multimedia)
  • enhancement of the consitency of your documentation by making use of css style sheets, skins and variables
  • enhancement of the searchability of information by making use of tables of contents, indexes, full text search, browse sequences and related topics
  • enhancement of the context relevancy of information by making use of conditional information and context sensitive help
  • speeding up of the time to market of your documentation by making use during the writing process of snippets, insets, hyperlinks and tagging

Company benefits

  • enhancement of the understanding of you products or service for your customers
  • reduction of the time-to-market of new products, services and software upgrades
  • reduction of the cost of editing, managing and distributing both internal and external information
  • reduction the cost of customer support

Convinced? Get in touch now.