Documentation Control

Documentation Control

Dokumentasi dalam Kamus Besar Bahasa Indonesia didefinisikan sebagai sesuatu yang tertulis , tercetak atau terekam yang dapat dipakai sebagai bukti atau keterangan. Adapun definisi dokumentasi adalah pemberian atau pengumpulan bukti-bukti dan keterangan.

Sedangkan dokumen control adalah sebuah dokumen yang saat ini penting atau mungkin menjadi penting untuk pengembangan dan pemeliharaan sistem perangkat lunak serta untuk pengelolaan saat ini dan masa depan hubungan dengan pelanggan. Oleh karena itu, persiapan, penyimpanan, pengambilan dan pembuangan dikendalikan oleh prosedur dokumentasi.Tipe dokumen control :

1. Pre project document

·         Contract review report

·         Contract negotiation meeting minutes

·         Software development contract

·         Software maintenance contract

·         Software development subcontracting contract

·         Software development plan

2. Project life cycle documents

·         System requirements document

·         Software requirements document

·         Preliminary design document

·         Critical design document

·         Database description

·         Software test plan

·         Design review report

·         Follow-up records of design review action items

·         Software test procedure

·         Software test report

·         Software user manuals

·         Software maintenance manuals

·         Software installation plan

·         Version description document

·         Software change requests

·         Software change orders

·         Software maintenance requests

·         Maintenance services reports

·         Records of subcontractor evaluations

3. SQA infrastructure documents

·         SQA procedures

·         Template library

·         SQA forms library

·         CAB meeting minutes

4. Software quality management documents

·         Progress reports

·         Software metrics reports

5. SQA system audit documents

·         Management review report

·         Minutes of management review meeting

·         Internal quality audit report

·         External SQA certification audit report

6. Customer documents

·         Software project tender documents

·         Customer’s software change requests

Komponen prosedur dokumentasi control :

• The controlled documents list
• Controlled document preparation
• Controlled document approval issues
• Issues of controlled document storage and retrieval issues.

The controlled documents list

Konstruksi yang tepat dari daftar ini didasarkan pada pembentukan otoritas untuk menerapkan konsep ini, apakah yang terkandung pada orang atau komite. Secara khusus, otoritas ini bertanggung jawab untuk:

Menentukan jenis dokumen untuk dikategorikan sebagai dokumen terkendali dan yang jenis dokumen terkontrol harus diklasifikasikan sebagai kualitas rekaman.

• Menentukan apakah tingkat kontrol yang memadai untuk setiap jenis dokumen dikategorikan sebagai dokumen terkendali. 
• Menindaklanjuti kepatuhan dengan daftar jenis dokumen terkendali. Subjek ini dapat dimasukkan dalam rencana audit mutu internal.
• Menganalisis tindak lanjut temuan dan memulai pembaruan yang diperlukan, perubahan, kepindahan dan penambahan pada daftar jenis dokumen terkendali. Jenis dokumen yang paling dikendalikan adalah dokumen yang dibuat secara internal oleh organisasi itu sendiri. Meskipun demikian, sejumlah besar dokumen jenis eksternal, seperti dokumen kontrak dan risalah rapat komite bersama, juga termasuk dalam kategori ini.

Controlled document preparation

Persyaratan dokumentasi yang terlibat dalam penciptaan dokumen baru atau revisi fokus dokumen yang ada pada kelengkapan, meningkatkan keterbacaan dan ketersediaan. Persyaratan ini diwujudkan dalam dokumen :

• Struktur
• Cara identifikasi
• Standar orientasi dan informasi referensi

Struktur dokumen bebas atau ditentukan oleh template. Sebuah metode identifikasi ini dirancang untuk memberikan setiap dokumen, versi dan revisi dengan identitas yang unik. Metode ini biasanya memerlukan notasi dari (a) sistem perangkat lunak atau nama produk atau nomor, (b) dokumen (type) kode dan (c) nomor versi dan revisi. Metode ini dapat bervariasi untuk berbeda jenis dokumen.

Orientasi dokumen dan informasi referensi mungkin diperlukan juga. Orientasi dan referensi informasi dukungan akses masa depan diperlukan dokumen dengan menyediakan informasi tentang isi dokumen dan kesesuaian dengan kebutuhan pengguna masa depan. Tergantung pada jenis dokumen, proporsi yang lebih besar atau lebih kecil dari informasi berikut item yang biasa dibutuhkan:

• Penulis dokumen
• Tanggal penyelesaian
• Orang yang menyetujui dokumen, termasuk posisi yang diselenggarakan
• Tanggal persetujuan
• Tanda tangan dari penulis dan orang-orang yang disetujui
• Deskripsi dari perubahan dalam rilis baru
• Daftar mantan versi dan revisi
• Sirkulasi daftar
• Kerahasiaan pembatasan