सिस्टम प्रलेखन में लिखित सामग्री होती है जिसका उपयोग कंप्यूटर हार्डवेयर या सॉफ्टवेयर सिस्टम के अनुप्रयोगों का वर्णन करने के लिए किया जाता है। प्रलेखन को मुद्रित मैनुअल, फ्लैश कार्ड, वेब पेज या ऑन-स्क्रीन सहायता पाठ के रूप में प्रदर्शित किया जा सकता है। सिस्टम प्रलेखन किसी भी कंप्यूटर सिस्टम की सफलता का एक महत्वपूर्ण घटक है। हालांकि, कई डेवलपर्स के पास अपने उत्पादों के लिए पर्याप्त दस्तावेज बनाने में मुश्किल समय है। विभिन्न प्रकार के प्रलेखन के अलग-अलग उद्देश्य होते हैं, इसलिए किसी भी प्रलेखन की सामग्री उसके इच्छित दर्शकों पर निर्भर करेगी।
परियोजना प्रलेखन
परियोजना प्रलेखन का उद्देश्य परियोजना का संपूर्ण वर्णन करता है। परियोजना प्रलेखन अधिकारियों, प्रबंधकों और कर्मचारियों को परियोजना के प्रस्तावित तरीकों, संसाधनों और उद्देश्यों के बारे में व्यापक दृष्टिकोण देता है। परियोजना प्रस्ताव दस्तावेज अधिकारियों को परियोजना के लक्ष्यों और बजट को दिखाते हैं। तकनीकी विनिर्देश परियोजनाओं के लिए हार्डवेयर और सॉफ्टवेयर आवश्यकताओं को रेखांकित करते हैं। परियोजना की योजना प्रोग्रामर, तकनीशियनों और डिजाइनरों द्वारा परियोजना के उद्देश्यों को प्राप्त करने के लिए उठाए गए कदमों का विवरण देती है।
टेस्ट डॉक्यूमेंटेशन
परीक्षण दस्तावेज़ उत्पाद के परीक्षण से पहले रिलीज़ होने की योजना के बारे में बताते हैं। गुणवत्ता आश्वासन विभाग दोनों आंतरिक "अल्फा" उपयोगकर्ताओं और बाहरी "बीटा" परीक्षकों के लिए परीक्षण योजनाएं विकसित करता है।परीक्षण दस्तावेज़ीकरण में परीक्षण निर्देश शामिल हैं - जैसे कि परीक्षकों के एक विशिष्ट सेट का पालन करना चाहिए - यह निर्धारित करने के लिए कि उत्पाद नियोजित है या नहीं। QA के कर्मचारी टेस्टर से अंक लॉग, बग लिस्ट और रिपोर्ट भी एकत्र करते हैं।
टीम प्रलेखन
टीम के सदस्यों के बीच विचारों का आदान-प्रदान एक परियोजना की सफलता के लिए महत्वपूर्ण है। टीम प्रलेखन वर्तमान परियोजना और भविष्य की परियोजनाओं पर उपयोग के लिए इन एक्सचेंजों को रिकॉर्ड करता है। टीम की योजना, कार्यक्रम और स्थिति अद्यतन टीम प्रलेखन के प्रमुख घटक हैं। चेकलिस्ट परियोजना प्रबंधकों को यह देखने में मदद करते हैं कि टीम ने कौन से कार्य पूरे किए हैं। टीम की बैठकों के मिनट प्रबंधकों को टीम के सदस्यों के बीच विभिन्न मुद्दों, सुझावों और असाइनमेंट को ट्रैक करने की अनुमति देते हैं।
उपयोगकर्ता दस्तावेज़
सिस्टम प्रलेखन का सबसे महत्वपूर्ण तत्व वह सामग्री है जो ग्राहक तक पहुंचती है। उपयोगकर्ता प्रलेखन को अत्यधिक तकनीकी शब्दजाल से मुक्त होना चाहिए और इसमें स्पष्ट, संक्षिप्त भाषा होनी चाहिए। उपयोगकर्ता मैनुअल आमतौर पर उपयोगकर्ता प्रलेखन का मुख्य घटक है, लेकिन उपयोगकर्ता अन्य स्रोतों पर भी भरोसा करते हैं। प्रशिक्षण संसाधन - जिसमें मैनुअल और वीडियो शामिल हैं - उपयोगकर्ताओं को जल्दी और आसानी से समझने में मदद कर सकते हैं कि सिस्टम कैसे काम करता है। जब सिस्टम उम्मीद के मुताबिक प्रदर्शन नहीं करता है, तो एक समस्या निवारण गाइड उपयोगकर्ता को समस्या को खोजने और हल करने में मदद कर सकता है।
