Considerations

Some technical documentation authors will balk at the notion that they are required to track every iteration of their documentation. However, if that information can be developed consistently and is required of all technical document authors, resistance tends to be minimized. Also, the means for storage and transmission of any technical documentation need to be considered in its creation. If the document is to be stored

Table 5.8 Sample Technical Document Cover Page

TECHNICAL DOCUMENT NAME:

CODE #:

Nature of the document:

Technical expertise/background required:

DOCUMENT CREATED

By:

Contact information:

Date:

For project:

DOCUMENT REVISED

By:

Contact information:

Date:

By authority of:

DOCUMENT REVISED

By:

Contact information:

Date:

By authority of:

DOCUMENT REVISED

By:

Contact information:

Date:

By authority of:

DOCUMENT ARCHIVED

By:

Contact information:

Date:

Location:

on the LAN, the repository should be consistent for all project documentation. If the document is to be stored in a physical file, the repository needs to be consistent, as well. That location needs to be communicated to project team members (as appropriate) to ensure that others can identify where the documentation is stored and can gain access to it as needed.

Was this article helpful?

0 0
Project Management Made Easy

Project Management Made Easy

What you need to know about… Project Management Made Easy! Project management consists of more than just a large building project and can encompass small projects as well. No matter what the size of your project, you need to have some sort of project management. How you manage your project has everything to do with its outcome.

Get My Free Ebook


Post a comment