प्रलेखन मानकों के बारे में

डॉक्यूमेंटेशन एक ऐसी चीज है, जिसके लिए बहुत कम लोगों की गर्म भावनाएँ हैं: उबाऊ, उबाऊ, नीरस। और, फिर भी, कभी-कभी इसकी आवश्यकता के बारे में कोई संदेह नहीं है: आखिरकार, किसी के बाद आप इसे उपयोग करने के लिए या इसके अलावा, इसे संशोधित करें। और फिर सवाल उठता है: प्रलेखन को सही कैसे बनाया जाए?

"दस्तावेज़ कैसे लिखना है" विषय पर बहुत सारे लेख हैं, लेकिन अगर आप इसे पहली बार लेने का फैसला करते हैं, तो यह तुरंत आपके लिए एक नए क्षेत्र में स्पष्ट नहीं है कि क्या लेखक एक मामला लिख ​​रहा है या एक गैग बना रहा है।

लेखों को हटाए बिना अपनी राय बनाने के लिए, आप दो तरीकों से जा सकते हैं: किसी प्राधिकरण में विश्वास करना या मानकों को देखना - यही वह समस्या है जहाँ समस्या की संभावना सबसे अधिक है।

कोई कह सकता है, "आह, मानकों! वे प्रलेखन से भी अधिक नारकीय उबाऊ हैं! " ठीक है, चलो झूठ नहीं बोलते हैं, थोड़ा है :) लेकिन अगर आपके पास इलेक्ट्रॉनिक प्रारूप में एक दस्तावेज़ है - तो सही चीज़ ढूंढना मुश्किल नहीं है। और इसके अलावा, अच्छी तरह से, पहले से ही मानकों के खंड को भिगोना आवश्यक है, अन्यथा यह खाली लटका हुआ है, यहां तक ​​कि आक्रामक रूप से।

हमारा।

हम सबसे पहले GOST- s की ओर मुड़ते हैं । वे विकास की तारीखों से निराश हैं (हालांकि, ऐसा लगता है कि वर्षों में प्रलेखन में बहुत बदलाव नहीं हुआ है) और मुफ्त में प्रोत्साहित कर रहे हैं।

GOST R ISO 9127-94 "उपभोक्ता सॉफ़्टवेयर पैकेज के लिए पैकेजिंग पर उपयोगकर्ता दस्तावेज़ और जानकारी" हमारे बीच सबसे अधिक पसंद किया जाने वाला मानक है। संक्षेप में (संपूर्ण दस्तावेज़ लगभग 20 पृष्ठों का है), उपयोगकर्ता प्रलेखन की संरचना और सामग्री के लिए बुनियादी आवश्यकताओं को इंगित किया गया है।
आधिकारिक पेज। पीडीएफ डाउनलोड करें।

GOST R ISO / IEC 15910-2002 "एक सॉफ्टवेयर टूल के लिए उपयोगकर्ता प्रलेखन बनाने की प्रक्रिया" - मानक अब इस सवाल का जवाब नहीं देता है कि "क्या" दस्तावेज़ में होना चाहिए, लेकिन "कैसे" दस्तावेज़ बनाया जाना चाहिए। इसके अतिरिक्त, एक उदाहरण के साथ दस्तावेज़ की शैली का विस्तृत विवरण है - यह एक टेम्पलेट बनाने के लिए काफी सुविधाजनक बात है: एक बार जब आप भाप लेते हैं (और टेम्पलेट में सब कुछ हथौड़ा करते हैं: चित्र के कैप्शन के संरेखण से), और फिर आप एक ही प्रकार के दस्तावेजों को गोंद करते हैं, और विभिन्न फ़ॉन्ट हेडर के साथ नहीं।
आधिकारिक पेज। पीडीएफ डाउनलोड करें।

GOST- श्रृंखला 19.xx - ESPD श्रृंखला, एक जुनून जो प्राचीन है (औसतन, 78 वें वर्ष में दस्तावेज बनाए गए थे), लेकिन वे GOST 9127 के रूप में संक्षिप्त हैं, कई प्रकार के दस्तावेजों की आवश्यकताएं।
परिचित होना।

GOST 34.602-89 "एक स्वचालित प्रणाली के निर्माण के लिए संदर्भ की शर्तें" - तकनीकी विशिष्टताओं के लिए मानक। धन्यवाद जैज़िस्ट ।

बुर्जुआ।

मेरे आक्रोश की कोई सीमा नहीं थी जब मुझे पता चला कि अंतर्राष्ट्रीय मानक स्वतंत्र नहीं हैं। यह ट्रैफ़िक नियमों को भुगतान करने जैसा है। लेकिन सिद्धांत रूप में, यह उचित हो सकता है: संगठन राज्य के स्वामित्व वाले नहीं हैं। वे चाहते हैं - वे अपने काम के लिए पैसे ले सकते हैं। सौभाग्य से, कई मानकों को सामान्य तरीके से, समुद्री डाकू तरीके से डाउनलोड किया जा सकता है।

IEEE Std 1063-2001 "सॉफ्टवेयर उपयोगकर्ता प्रलेखन के लिए IEEE मानक" - दस्तावेज़ उपयोगकर्ता निर्देशों की संरचना, सामग्री और प्रारूप की आवश्यकताओं की रूपरेखा देता है।
आधिकारिक पेज।

IEEE Std 1016-1998 "IEEE अनुशंसित सॉफ्टवेयर डिजाइन विवरण के लिए अभ्यास" - सॉफ्टवेयर की वास्तुकला का वर्णन करने वाले दस्तावेजों के लिए सिफारिशें, अर्थात् तकनीकी विवरण के लिए।
आधिकारिक पेज।
मुझे विशेष रूप से दस्तावेज़ की मुख्य सामग्री (यहाँ एक मुफ्त अनुवाद) का टैबलेट-एक्सट्रैक्ट पसंद आया:

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

आईएसओ / आईईसी एफडीआईएस 18019: 2004 "डिजाइन और एप्लिकेशन सॉफ्टवेयर के लिए उपयोगकर्ता प्रलेखन की तैयारी के लिए दिशानिर्देश" - उपयोगकर्ता प्रलेखन बनाने के लिए सिफारिशें। तो कहने के लिए, सलाह "नोट की मालकिन।" बहुत सारे उदाहरणों के साथ एक बहुत अच्छा मार्गदर्शक (IMHO, यह प्रलेखन निर्माण के बहुत पहले या शुरुआत में पढ़ने के लिए अधिक उपयुक्त है, क्योंकि यह पूरी तरह से इस प्रक्रिया को पूरी तरह से नियोजन से ही समेटता है)। इसके अलावा अनुप्रयोगों में चेकलिस्ट हैं "विकासशील दस्तावेज की प्रक्रिया में क्या करना है" और "दस्तावेज़ में क्या होना चाहिए"
आधिकारिक पेज।

ISO / IEC 26514: 2008 "डिजाइनरों और उपयोगकर्ता प्रलेखन के डेवलपर्स के लिए आवश्यकताएँ" एक काफी हाल ही में है और, सामग्री, उपयोगी दस्तावेज को देखते हुए। लेकिन, बस, जाहिरा तौर पर, इसकी ताजगी के कारण, यह मानक कहीं भी मुफ्त में नहीं मिलता है। कम से कम मैं ऐसा नहीं कर सकता था।
आधिकारिक पेज।

ये दस्तावेज के साथ सबसे अधिक निकटता से जुड़े मानक थे। वे शुरुआत में तकनीकी टेक्स दोनों के लिए उपयोगी हो सकते हैं, और, उदाहरण के लिए, फ्रीलांसर के लिए, जो "एक श्वेत और एक रीपर, और पाइप पर एक दोस्त है।

स्पष्टीकरण, परिवर्धन और उपयोगी लिंक का स्वागत है)

UPD : बहुत जानकारीपूर्ण टिप्पणी , धन्यवाद lkochetova

UPD1 : मेरे विवेक ने मुझे प्रताड़ित किया, और लेख में अब उन मानकों को डाउनलोड करने के लिए सीधे लिंक नहीं होंगे जो स्वतंत्र रूप से वितरित नहीं हैं। यदि आपको उनकी आवश्यकता है, तो Google के लिए मुश्किल नहीं है।

UPD2 : GOST 34 * के अनुसार लेख का दस्तावेज़ीकरण भी देखें - यह परियोजना प्रलेखन के लिए घरेलू मानकों का एक विस्तृत विश्लेषण है।