Define Documentation Standards

From DocWiki

Jump to: navigation, search
Phase: Phase 3
Activity: Data Standards
Sort Order: 9
Page Status: Unchecked
Include Task?: Used
Task Status: Active
Short Name: Documentation Standards
URL:
Description: As stated.
Objective: Documentation Standards are set for the creation and maintenance of corporate information. Standards can be set up enterprise wide or within a function or department. The scope of documentation standardization should include three important components: first, document creation, processes and templates, and second, document naming conventions and third, document folder structures. All of these components are designed to enable people to find high quality information quickly.

The enterprise should define documentation standards based on their specific requirements and corporate culture. There is a danger that an enterprise can create documentation standards that are overly complex and burdensome. So, it is important to be flexible and take an incremental approach.

Once documentation standards are implemented, processes should be put in place to set up security groups by functional area where some users have access to maintain and modify documentation and other groups can only view the documentation. Successful documentation standards also encourages employees to keep good records through incentives such as line items in employee goals and reviews.

Inputs: Include:
  • Existing Documentation Standards and Policies
  • Department documentation requirements
Outputs: [[HasOutputs::Include:

Documentation Standards include:

  • Documentation Templates
  • Document Naming Conventions
  • Shared Drive Configuration and Folder Structures
  • Security Groups]]
Staffing:
Total Hrs:
Duration:
Start Time:
Cost:
Important yellow.pngThis page is unchecked !!!


Place whatever "free text" you wish here; it will appear at the bottom of the task listing.

Personal tools