knowledgeDoc

Frequently Asked Questions

Why do I need documentation?

There are five main reasons:

  • To make sure everyone in the organisation is working in the most efficient way.
  • To save costs in the long term by minimising support callouts and help desk enquiries.
  • To insure yourself against knowledge loss when people leave the organisation.
  • To comply with regulatory requirements.
  • To enhance your reputation and increase sales of your product by having professional quality documentation to show your customers.

Who does Knowledgedoc write for?

Our documentation is for your audience. We have the skills to view everything from the perspective of the end-user, whatever the education level or background of that person.

As an example, for one of our customers we wrote:

  • A technical network architecture document for computer network support staff. The document contained language such as Citrix, thin client and other networking jargon.
  • An application user guide for staff with limited computer experience. The document included information about how to start up the application and minimised its use of jargon as well as catering to more experienced users.

What can Knowledgedoc write?

The easiest way to describe what a technical writer writes is anything non-fiction.

The materials we have written include:

Safety

  • Work method statements (WMS')
  • Standard operating procedures (SOPs)
  • Forms
  • Risk management controls (RMCs)
  • Federal Safety Commission accreditation application
  • Building facilities procedures
  • Family Day Care procedures.

Computer applications

  • User manuals
  • Online help and context-sensitive help (F1)
  • Web-based help
  • Functional design and detailed design documentation for developers
  • Network architecture documentation
  • Training materials
  • Technical support documentation.

Warehousing

  • User guides for warehousing applications
  • Training materials for staff working in all parts of a warehouse operation - sales office, warehouse management, warehouse floor
  • Policies and procedures.

Engineering

  • Operator's manuals
  • Manufacturer's data reports (MDRs).

General

  • Standard operating procedures
  • Training materials - online, instructor-led and competency-based
  • Website and intranet content
  • HR manuals
  • Financial procedures
  • Quality systems documentation
  • Marketing brochures
  • Newsletters.

What tools does Knowledgedoc use?

We use whatever tools suit your organisation. For example, we:

  • use Author-it extensively for its single-sourcing capabilities - visit the Author-it website to find out more about Author-it
  • are power users of Microsoft Word
  • have used RoboHelp and other authoring software.

We bring together everything you need to produce quality documentation with expertise in graphics capture and manipulation, other Microsoft Office products and web publishing.

Why do I need a technical writer?

Technical writers are skilled at producing readable, consistent and user-friendly texts, taking into account the needs of the audience and the stakeholders.

As part of everyday business life staff are required to write high quality, clear documentation such as business cases, risk assessments, instruction manuals, training guides, user guides and procedures.

Managers and other staff are often left to struggle with documentation and writing tasks themselves. Due to lack of time and expertise the translation and transmission of information to end users and stakeholders can be ineffective.

A technical writer can:

  • save time and money
  • quietly work alongside your staff to produce clear and concise documentation
  • streamline documentation processes
  • assist growth into the future.

By employing a technical writer, you are choosing to bring a new a level of expertise into your business environment, whilst at the same time relieving your staff to do what they do best. Contact us today and discover the difference that a technical writer can make.