Documentation (डॉक्यूमेंटेशन) :-
Documentation वह प्रक्रिया है जिसमें किसी Software या Program से संबंधित सभी आवश्यक जानकारी को लिखित रूप में सुरक्षित किया जाता है। इसमें Program का उद्देश्य, कार्य करने की विधि, उपयोग करने के निर्देश, तथा रखरखाव (Maintenance) से संबंधित जानकारी शामिल होती है।
English:
Documentation is the process of recording all important information related to a software or program in written form. It includes the purpose of the program, working procedure, usage instructions, and maintenance details.
Documentation के उद्देश्य (Objectives) :-
Program को समझना आसान बनाना
Future Maintenance में सहायता करना
नए Developers को जानकारी देना
Errors को कम करना
User को सही तरीके से Software उपयोग करने में मदद करना
Types of Documentation (डॉक्यूमेंटेशन के प्रकार) :-
Documentation मुख्यतः दो प्रकार की होती है:
1. Internal Documentation (आंतरिक डॉक्यूमेंटेशन) :- हिंदी:
जो Documentation Program के Source Code के अंदर लिखी जाती है, उसे Internal Documentation कहते हैं।
English:
Documentation written inside the source code is called Internal Documentation.
उदाहरण (Python Comments)
Comments
Function Description
Variable Description
Module Description
Inline Notes
Programmer को Code समझने में मदद मिलती है।
Debugging आसान होती है।
Code Maintenance सरल हो जाता है।
2. External Documentation (बाहरी डॉक्यूमेंटेशन)
जो Documentation Source Code के बाहर अलग से तैयार की जाती है, उसे External Documentation कहते हैं।
English:
Documentation prepared separately outside the source code is called External Documentation.
उदाहरण
User Manual
Installation Guide
System Documentation
Technical Documentation
API Documentation
लाभ (Advantages)
User को Software उपयोग करना आसान होता है।
Installation और Configuration में सहायता मिलती है।
Technical Team को System समझने में मदद मिलती है।