Technical Writing

Common deliverables

• user manuals
• SOPs (standard operating procedures)
• installation guides
• maintenance manuals
• work instructions
• IFUs (instructions for use)
• API documentation
• policy and procedures manuals
• technical reports
• online help systems
• FAQs
• instructional videos

Visual learning

It is well-established that people often learn best with the aid of visuals. As the saying goes: "a picture tells a thousand words". With that in mind we always endeavour to bolster our technical documentation – both informational and instructional – with visuals. Common visuals include illustrations, drawings, diagrams, schematics, tables, photographs and screenshots.

Services

Abelard Consulting is a specialist producer of technical documentation and manager of documentation projects. We provide the full spectrum of documentation services: from editing a single document written by others to managing fully out-sourced project teams writing user documentation of many types, in many media and in many languages. Our whole-of-project management encompasses:

• preparation of documentation plans
• job scoping and estimating
• document design
• developing content (for paper and online publication)
• author-independent review and editing
• technical illustration and
• localisation.

We can also take on discrete phases in the typical documentation development lifecycle (such as just review and editing, or just localisation).

Localisation and translation

Abelard Consulting has considerable experience localising documentation (i.e. converting it from one variant of English to another). Some examples: Chinglish to Australian English, or American English to Australian English.

We have also built up strong relationships with the technical translator community in Australia and the United States. Technical translation into Asian, European and South American languages can be integrated into any documentation project.