Scribd
Upload
39 views2 pages

System Documentation Strategy Notes

Uploaded by

susildahal234
Copyright
© © All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as PDF, TXT or read online on Scribd
39 views2 pages

System Documentation Strategy Notes

Uploaded by

susildahal234
Copyright
© © All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as PDF, TXT or read online on Scribd
You are on page 1/ 2

Unit 3: System Documentation Strategy (4 Hrs)

3.1 Quality System and Engineering Data Records


Quality System and Engineering Data Records refer to the documentation that ensures the
system meets quality standards throughout its lifecycle. These records include detailed
technical data, processes, and reports that help maintain consistency and reliability of the
system.

Examples of Engineering Data Records include:


- Design documents
- Test reports
- Configuration files
- Change logs

3.2 System Design and Development Data


System Design and Development Data includes all the information required to design, build,
and maintain a system. It covers the initial requirements, design specifications, and ongoing
development documentation to track system changes.

Key components include:


- Requirement documents
- Design blueprints
- Development guidelines
- Version control records

3.3 Data Accession List (DAL) and Data Criteria List (DCL)
The Data Accession List (DAL) is a list of all the documents and records related to the
system that need to be maintained. The Data Criteria List (DCL) defines the criteria for what
type of data must be included, such as accuracy, completeness, and format.

In simple terms:
- **DAL**: A list of documents that need to be managed.
- **DCL**: Rules for creating and maintaining those documents.

3.4 Documentation Levels of Formality


Documentation can vary in formality depending on the project requirements. It can range
from highly formalized reports to informal notes and memos. The level of formality depends
on the criticality of the system and the stakeholders' needs.

Levels of formality include:


- **Informal Documentation**: Emails, notes, and quick updates.
- **Semi-Formal Documentation**: Meeting minutes, progress reports.
- **Formal Documentation**: Technical specifications, contracts, user manuals.
3.5 System Documentation Issues
System documentation issues refer to the challenges faced in creating and maintaining
documentation. These issues include outdated documents, lack of standardization,
incomplete records, and difficulties in accessing relevant information.

Common issues:
- **Outdated Documentation**: Documents are not updated with system changes.
- **Inconsistent Formats**: Different formats make it hard to manage documents.
- **Accessibility**: Difficulty in finding and accessing the right documents when needed.

You might also like