एक प्रोग्रामर को अपने सम्पूर्ण जीवन काल में एक कार्यक्रम या प्रोग्राम को बनाए रखने के लिए सक्षम करने के लिए आवश्यक दस्तावेज को दो श्रेणियों में विभाजित किया जा सकता है;
Internal Documentation ( आंतरिक दस्तावेज़ीकरण )
External Documentation ( बाह्य दस्तावेज़ीकरण )
Internal Documentation ( आंतरिक दस्तावेज़ीकरण )
इस प्रकार के दस्तावेज़ीकरण में प्रोग्राम के उन पहलुओं को कवर करता हैं या शामिल किया जाता है जो प्रोग्रामिंग भाषा के वाक्य-रचना को समाहित करते हैं या फिर प्रोग्रामिंग भाषा सिंटैक्स में शामिल होते हैं।
Internal Documentation Should Includes ( इंटरनल डॉक्यूमेंटेशन में शामिल होना चाहिए )
डेटा आइटम और प्रक्रियाओं का वर्णन करने के लिए उपयोग किए जाने वाले मीनिंग फूल नाम या सार्थक नाम।
समग्र रूप से पूर्ण प्रोग्राम को बनाने वाले एक प्रोग्राम के कार्य और प्रोग्राम को शामिल करने वाले मॉड्यूल से संबंधित टिप्पणियाँ।
प्रति पंक्ति एक निर्देश, निर्देशों के संबंधित समूह का इंडेंटेशन, मॉड्यूल को अलग करने वाली रिक्त रेखाएं।
External Documentation ( बाह्य दस्तावेज़ीकरण )
इस श्रेणी में सहायक दस्तावेज शामिल हैं, जिन्हें किसी भी प्रोग्राम के साथ मैनुअल या फोल्डर में रखा जाना चाहिए और व्यवस्थित किया जाना चाहिए। यह आवश्यक है कि जैसे ही किसी प्रोग्राम में परिवर्तन किए जाते हैं, उसके बाह्य दस्तावेज़ीकरण को एक साथ अद्यतन ( Updated ) किया जाता है।
External Documentation Should Includes ( बाह्य दस्तावेज़ीकरण में शामिल होना चाहिए )
स्रोत प्रोग्राम की वर्तमान या नवीनतम सूची बनाना।
प्रोग्राम के उद्देश्य और संचालन के तरीके को परिभाषित करने वाला एक दस्तावेज।
संरचना आरेख ( चित्र ) मॉड्यूल के पदानुक्रमित संगठन को दर्शाता है।
प्रोग्राम में किसी सूत्र या जटिल गणनाओं की व्याख्या या समझाना।
संसाधित या प्रोसेस किए जा रहे डेटा की विशिष्टता और स्पष्टीकरण।
उपयोगकर्ताओं और मुद्रित रिपोर्टों ( Printed Reports ) के साथ बातचीत करने के लिए उपयोग की जाने वाली स्क्रीन का प्रारूप।
प्रोग्राम के संचालन को मान्य ( Validate ) करने के लिए उपयोग किए जाने वाले परीक्षण डेटा ( Test Data ) आदि।
🌼Thank you very much for giving your valuable time!🙏
_edited.jpg)
Comments