Project Library
You will build a Project Library consisting of several documents. You may not write every
document listed below, but you will end up with a large body of documentation. It is far better to
plan the library now, order it, and let the binders fill up based on that plan, rather than trying to
sort out pages of documents, flow charts and Visio schematics in the middle of the project.
Think through the project early on and come to a conclusion as to which documents you'll write.
These documents need not be novel-length in size. In fact, there are two tendencies to avoid in
documentation: there is either none at all, or far too much. In each case no one reads any
documentation, either because it doesn't exist, or because the sheer volume dissuades them.
The Project Manager will not actually write each of the documents listed below. Identify the
most appropriate resource on your staff based on skill sets and activities with the project and
notify them early on of their assignments. Make it clear what they are assigned to write and how
that document fits into the overall schedule. Make it clear when you expect to see the drafts and
final copy of the documents.
Problem Specification. The first order of business is to write the Problem Specification.
Describe the requirements of the project based on the RFP, the Contract and any conversation
with account reps and client team members. NOTE: The Problem Specification should describe
the problems and needs of the project as they are understood, and avoid describing the solutions
to the problem -- that will be accomplished in the Design Specification.
Design Specification. Following completion of the Problem Specification you will write the
Design Specification. This document illustrates in detail the solutions to the project problems as
they are outlined in initial documentation.
Test Specifications. You will write Test Specifications for Integration Test, System Test, and
Acceptance Test. Identify specifically what you are testing for, and create test scripts, checklists,
sample test data, and test plans.
Technical Notes. Describe specific technical aspects of the project not directly related to the
design solution. Include hardware and software inventory and specifications; site licenses
needed and purchased; vendor names, contacts and phone numbers; and contractor names and
contacts.
Coding Specification. Once you have described the solution in narrative and diagrammatic form,
begin detailing the design. Include schematics, software engineering process and sample code.
Change Orders. Any time the client, one of your staff, or a contractor describes or requests
process which deviates from the Design Specification you must document that event. Even if the
change is not to be implemented, make a brief note that the change to the specification came up.
In those cases where changes are accepted, note who originated the change, note observations on
how the change will impact the overall progress of the project, and distribute your observations
to the client and appropriate staff, as well as your superiors. Approved changes which
significantly alter the Design Specification should require contract negotiations prior to
implementation.
Test Documents. Document all test results. Note what works and what does not. Distribute
your findings to the client and appropriate staff as well as your superiors.
Status Reports. You will engage in scheduled reviews of the project, per your Project Timeline.
Document the reviews and distribute these to the client, appropriate staff and your superiors.
Communications Log. Possibly the most important piece of documentation: document all
communication between you, your staff, and the client. Maintain a log for all modes of
communication you engage in, per your Communication plan (see below). Having decided on
the protocols (FAX, E-mail, Memo, phone, meetings) and parameters (daily, weekly, etc.) of
your client interactions start binders now that will contain copies of all communications between
you and the client. Maintain a binder in which you keep copies of each FAX (or E-mail, etc) you
send, as well as those you receive.
DOCUMENTS, PHASES, FUNCTION, STAFF PARTICIPATION & FORMAT