Standards and tools in production and maintenance of system documentation

• Main Authors: Sulaiman, Shahida, Idris, Norbik Bashah, Uddin, Shamsul Sahib
• Format: Article
• Language: English
• Published: Penerbit UTM Press 2005
• Subjects: QA76 Computer software
• Online Access: http://eprints.utm.my/id/eprint/83/1/ShamsulSahibUddin2005_StandardsAndToolsInProduction.pdf; http://eprints.utm.my/id/eprint/83/
• Institution: Universiti Teknologi Malaysia

Implementation of a standard in a software development or maintenance process will provide guidelines on how to conduct the activities in the phases of software life cycle including the documentation to be produced. In addition, the use of Computer-Aided Software Engineering tools or workbenches can automate parts of documenting activities. Despite the importance of standard and tools to be utilised, they are still not widely used. Thus, software engineers still confront with the problems related to documentation particularly system documentation. This paper presents the result of a survey in Malaysia with the main goal to study software engineers' current practice in production and maintenance of documentation based on characteristic, behavior, belief and attitude. Finally, we highlight on what kind of tools should be introduced, why it is introduced and when or how it should be introduced to support the practice. ABSTRAK; Pelaksanaan sesuatu piawai di dalam proses pembangunan atau pengubahsuaian akan menghasilkan garis panduan bagaimana menjalankan aktivitiaktiviti di dalam fasa-fasa kitar hidup perisian termasuk dokumentasi yang perlu dihasilkan. Di sam ping itu juga, penggunaanalat kejuruteraan perisian berbantukan komputer atau 'workbenches' boleh mengautomasikan sebahagian daripada aktiviti-aktiviti dokumentasi dengan lebih piawai. Walaupun kepentingan piawai dan alat-alat tersebut boleh dimanfaatkan, tetapi pembangun sistem masih tidak menggunakannya secara meluas. Jurutera-jurutera perisian masih berhadapan dengan masalah-masalah berkaitan dengan dokumentasi terutamanya dokumentasi sistem. Rencana ini bertujuan untuk membentangkan hasil kaji selidik yang telah dijalankan di Malaysia. Matlamat utama kajian adalah untuk mengkaji amalan semasa juruterajurutera perisian di dalam penghasilan dan pengubahsuaian dokumentasi berdasarkan sifat, tingkah laku, kepercayaan dan sikap. Basil kajian juga dapat mengenat pasti apakah Jenis aoo yang perlu keMpllta diperkenalkan dan bila atau bagaimana ia harus diperkenalkan untuk menyokong amalan tersebut.