| |
 |
|
Oracle Tips by Burleson |
Documentation
Are processes, procedures, checklists, and other
aspects of job responsibilities documented willingly and completely?
Is documentation
shared among co-workers? Is
documentation accurate and kept up-to-date?
The downfall of many computer professionals is
documentation. Technical personnel enjoy working on technical issues
and building technical solutions. Many of them either do not document
processes and procedures at all, or they compile minimal documentation
to satisfy the requirement. Documentation is essential so that the IT
teams follow the proper procedures, can minimize the time for problem
resolution, cross-train team members, and standardize the
environments.
In one example, a data modeler was very good at
documenting his work completely, in understandable language, and with
good visuals. He would explain the documentation to
the team as a whole, work with co-workers individually if necessary,
and willingly accepted any questions that arose. He also ensured that
the information was widely published and highly available, posting it
to the company intranet website. Last but not least, the documentation
was kept up-to-date in a timely manner. This is too often a rarity
among technical professionals.
Failing to document IT policies, procedures, and
checklists is not helpful to the efficient and effective operation of
the department. In cases where documentation has
been compiled, inaccurate information can also degrade the quality and
quantity of IT services provided. The IT staff must be made aware of
the requirement to produce accurate documentation surrounding their
job functions and the consequences of not meeting expectations.
 |
For more details and scripts, see my new book "
Oracle
Tuning: The Definitive Reference", over 900 pages
of BC's favorite tuning tips & scripts.
You can buy it direct from the publisher for 30%-off and get
instant access to the code depot. |
|
