Technical Documentation

3B2 Documentation and Knowledge Transfer

Introduction

This topic provides an overview of the aims of the Documentation Team and the Advent Documentation System (ADS).

Documentation

Documentation is the exchange of information in writing. The art and technique of using words effectively to impart information and ideas is therefore essential for good technical documentation. Supplying documents and supporting references is crucial for successful software. The responsibilities of the Advent Documentation Team are the collation, synopsis and coding of printed material for future reference. To this end, the Advent Documentation Team organise the collection of records that describe the structure, purpose, operation, maintenance and data requirements for 3B2.

Advent Documentation System (ADS.)

We want to make it easy for users to find and understand up to date documentation. In order to achieve this the first batch of the new Advent Documentation System (ADS) is scheduled to be implemented by the first quarter of 2003. The two main aims of the ADS are:

Consolidation of all 3B2 documentation across multiple languages.
Easier access and location of information through an XML Knowledge Base using CMS functionality.

XML Knowledge Base

XML Knowledge Base using custom built in-house DTD:

Single data source.
Separate uniquely named XML instances.
Separate examples, building example repository.
Implement a Content Management System (CMS).
Accessible via the Internet.

Up To Date Documentation

New documentation produced to user requirements using the latest set of information in the database:

Using a CMS to enable Knowledge Base functionality.
Intelligent searching utilising the additional information contained in the XML mark-up (see below).
PDF production.
Customisation of manual content and searching by:

Version.
3B2 feature.
Language.

Understanding and working with others

Understanding user's informational and work motivations is crucial to enable users to solve problems. It is necessary to provide task orientated information, such as practical examples. Feedback from users is essential. For specific web, manual and documentation feedback please contact documentation@3b2.com

Successful communication also relies on working in conjunction with others such as:

Encouraging the User Group Forum.
Extensive collaboration with 3B2 programmers and Advent project technicians for the latest information.
Working in unison with Training and Support for a cohesive support network.

Overall

The Advent Documentation Team seeks to keep up with 3B2 and industry developments and provide accurate, comprehensive, quality documentation to make life easier and reduce frustration for users. Advent believe that it is important to achieve overall document effectiveness. This is not just correctness at sentence level but a more comprehensive approach to editing, document design and transference of technical, often complex concepts.

References

The existing 3B2 Macro Search & Reference and PDF manual downloads are available online at http://support.3b2.com.

For a tour of the 3b2 support website please visit support.3b2.com/tour website.