उजागर करना, जैसा कि यहाँ इस शब्द का उपयोग किया गया है, यह टेक्स्ट पर ध्यान आकर्षित करने के लिए टाइपोग्राफिकल प्रभावों का उपयोग है। ये प्रभाव इटैलिक्स, बोल्ड, सभी अक्षर बड़े, उद्धरण चिह्न, रंग, और इसी तरह शामिल कर सकते हैं। हाइलाइटिंग पाठकों का ध्यान आकर्षित करती है—या उन्हें "क्यूज़" करती"—उन क्रियाओं की ओर जिन्हें उन्हें करना चाहिए या उन सूचनाओं की ओर जिन्हें उन्हें सावधानीपूर्वक विचार करना चाहिए।
तकनीकी लेखन—की समस्याओं में से एक, विशेष रूप से कंप्यूटरों के बारे में तकनीकी लेखन—, जोर देने की विभिन्न तकनीकों के उपयोग से संबंधित है। दुर्भाग्यवश, कुछ तकनीकी पाठ यहाँ जिन विभिन्न जोर देने की तकनीकों पर चर्चा की गई है, उनके उपयोग में अति कर देते हैं।
हाइलाइटिंग के मूल सिद्धांत
जोर देने के कुछ मौलिक सिद्धांतों पर विचार करें:
- प्रायः कोई भी विशेष पाठ प्रभाव जो साधारण मुख्य पाठ से अलग होता है, जोर देने की तकनीक के रूप में कार्य कर सकता है। इटैलिक्स, बोल्ड, अंडरस्कोर, कैप्स, विभिन्न आकार के टाइप, वैकल्पिक फॉन्ट, रंग, और विभिन्न ग्राफिकल नवाचार (शोइंग, रिवर्स कलर, आउटलाइन फॉन्ट्स) जोर देने की तकनीक के रूप में काम कर सकते हैं।
- अत्यधिक उपयोग करने पर, किसी भी जोर देने की तकनीक या जोर देने की तकनीकों के संयोजन से उनकी जोर देने की क्षमता खो सकती है और वे व्यस्त और ध्यान भंग करने वाली बन सकती हैं। अत्यधिक उपयोग करने पर, किसी भी जोर देने की तकनीक या उनके संयोजन के कारण पाठक किसी पाठ को पढ़ने के लिए हिचकिचा सकते हैं, या उससे पूरी तरह बच भी सकते हैं। ध्यान दें कि इस नोटिस के अत्यधिक हाइलाइट किए गए संस्करण को इसमें पढ़ना कितना अपठनीय है। पॉपअप; साथ ही ध्यान दें कि यह उस नोटिस प्रकार का उपयोग नहीं करता जो में अनुशंसित है सूचनाएँ.
- जब विस्तारित पाठ पर जोर देना आवश्यक हो, तो का उपयोग करें विशेष सूचना प्रारूप (उदाहरण के लिए, पूरी तरह बोल्ड या सभी बड़े अक्षरों में पैराग्राफ बनाने के बजाय).
- जिन पाठों पर ज़ोर दिया गया है और जिन जोर देने की तकनीकों का उपयोग किया गया है, उनके बीच एक सावधानीपूर्वक योजनाबद्ध कार्यात्मक संबंध होना चाहिए।
- पाठकों को भ्रमित होने से रोकने के लिए जोर देने की तकनीकों का सुसंगत रूप से उपयोग किया जाना चाहिए।
- एकरूपता सुनिश्चित करने के लिए, आपको एक स्टाइल गाइड या स्टाइल शीट का उपयोग करना चाहिए, जो आपके उन सभी निर्णयों को दर्ज करती है और फिर तय करती है कि आप जोर देने की तकनीकों का उपयोग कैसे करेंगे।
- अपने पाठकों को आपकी हाइलाइटिंग योजना समझने में मदद करने के लिए, आप अपने दस्तावेज़ में कहीं एक संक्षिप्त अनुभाग (आम तौर पर प्रस्तावना में) शामिल कर सकते हैं जिसमें बताया गया हो कि आप जोर देने की तकनीकों का उपयोग कैसे करने जा रहे हैं।
निम्नलिखित चर्चा में, आप देखेंगे कि किसी भी जोर देने की तकनीकों की व्यवस्था काफी जटिल हो सकती है और लेखकों व संपादकों के लिए याद रखना कठिन हो सकता है। आप यह भी देखेंगे कि जोर देने की तकनीकों का उपयोग करने के कई समान रूप से मान्य तरीके हैं: उदाहरण के लिए, कुछ मामलों में साधारण जोर देने के लिए मोटे अक्षर (बोल्ड) या तिरछे अक्षर (इटैलिक्स) का उपयोग करना मनमाना होता है। इस समस्या को दूर करने के लिए, आपको हाइलाइट करने के दिशा-निर्देशों को एक शैली गाइड में दस्तावेज़ित करना चाहिए, जिसे लेखक और संपादक (या केवल आप स्वयं) संदर्भ के लिए देख सकें। एक शैली मार्गदर्शक यह सिर्फ उन निर्णयों का रिकॉर्ड है जो आप और आपकी दस्तावेज़ीकरण टीम ने यह निर्धारित करने के लिए किए हैं कि आप चाहते हैं कि आपके दस्तावेज़ कैसे दिखें।
आपके पाठकों को यह भी सूचित किया जाना चाहिए कि आप किस हाइलाइटिंग योजना का उपयोग करने का इरादा रखते हैं। यह प्रस्तावना में निपटाया जा सकता है: एक ऐसा अनुभाग शामिल करें जिसका शीर्षक "हाइलाइटिंग" या "टाइपोग्राफिकल कन्वेंशन्स" हो, जहाँ आप सूचीबद्ध करें कि आप इटैलिक्स (तिरछे अक्षर), बोल्ड (मोटे अक्षर), फॉन्ट (लिपियाँ) और अन्य ऐसे प्रभाव कैसे उपयोग करते हैं। उदाहरण के लिए, अध्याय में प्रस्तावनाओं पर चर्चा देखें तकनीकी पुस्तकों के मानक घटक
विशिष्ट जोर देने की तकनीकें
अगला अनुभाग विभिन्न ज़ोर देने की तकनीकों को क्रमवार रूप से बताता है और सामान्य प्रथाओं की व्याख्या करता है।
नोट: चीज़ों को सरल रखने के लिए, समस्याओं को उजागर करना तालिकाएँ, आकृतियाँ, शीर्षक, सूचियाँ, और सूचनाएँ उन अनुभागों में प्रस्तुत किए जाते हैं।
साहसी
प्रकाशन में, विशेषकर तकनीकी प्रकाशन में, बुनियादी जोर देने के लिए बोल्ड का उपयोग करना चाहिए या इटैलिक्स का, इस पर प्रचलन मिश्रित है। उदाहरण के लिए, यदि आप यह ज़ोर देना चाहते हैं कि पाठकों को कंप्यूटर को पहले शटडाउन किए बिना बंद नहीं करना चाहिए, तो "नहीं" को बोल्ड या इटैलिक्स किया जा सकता है। पारंपरिक रूप से इटैलिक्स का उपयोग किया गया है, लेकिन शायद कंप्यूटरों के कारण, बोल्ड का भी सामान्यतः उपयोग होता है।
आप जो भी तकनीक इस्तेमाल करें, उसे अपनी संपूर्ण पाठ्य सामग्री या संबंधित ग्रंथों के संग्रह में लगातार लागू करें। वैसे, पाठक अक्सर जोर के विभिन्न स्तरों के बीच फर्क नहीं पहचान पाएँगे: उदाहरण के तौर पर, महत्वपूर्ण पाठ के लिए इटैलिक्स और अत्यधिक महत्वपूर्ण पाठ के लिए बोल्ड का प्रयोग अधिकांश पाठकों के लिए बेअसर रहेगा।
यदि आप पूरे पैराग्राफ को बोल्ड करने के लिये प्रलोभित होते हैं, तो ऊपर चर्चा किए गए जोर देने के सिद्धांतों में से एक को याद रखें: किसी जोर देने वाली तकनीक का अत्यधिक उपयोग उस तकनीक के प्रभाव को खो देता है। इतना ही नहीं, बल्कि अत्यधिक जोर देने से पाठक पढ़ने के लिए कम इच्छुक होते हैं। पूरी तरह से बोल्ड किए गए पैराग्राफ को ध्यान से पढ़ने के बजाय, पाठक उसे पूरी तरह अनदेखा कर सकते हैं!
एक पूरा बोल्ड पैराग्राफ बनाने की बजाय, उसका उपयोग करें विशेष सूचना प्रारूप. इसमें, एक प्रमुख शब्द (उदाहरण के लिए, "महत्वपूर्ण", "नोट", "खतरा", "सावधानी", "चेतावनी") बोल्ड किया जाता है, जबकि शेष पाठ सामान्य रोमन में छोड़ा जाता है (यानी, नियमित मुख्य पाठ के समान फ़ॉन्ट और शैली)।
तकनीकी पाठों में बोल्ड का वैध उपयोग काफी भिन्न होता है। जब तक आप ऐसी योजना बनाते हैं जो सीधे पाठक की आवश्यकता और पाठ (या प्रौद्योगिकी) की विशेषताओं से जुड़ी हो और जो अत्यधिक उपयोग की ओर न ले जाए, बोल्ड का उपयोग प्रभावी रहेगा।
यहाँ बोल्ड के कुछ सामान्य, मानक उपयोग दिए गए हैं:
- सरल ज़ोर। जैसा कि पहले चर्चा की गई है, कुछ तकनीकी पाठ पारंपरिक इटैलिक्स के बजाय साधारण जोर देने के लिए बोल्ड का उपयोग करते हैं। उदाहरण के लिए, "करें नहीं शटडाउन करने से पहले कंप्यूटर को बंद कर दें।
- आदेश। कंप्यूटर टेक्स्ट में सामान्यतः कमांड्स के लिए बोल्ड का उपयोग किया जाता है, उदाहरण के लिए, "इस्तेमाल करें चलना यूनिक्स फ़ाइलों का नाम बदलने का आदेश।" जोर देने की तकनीकों के पूरे सेट की समीक्षा के लिए कंप्यूटर टेक्स्ट को हाइलाइट करने वाले अनुभाग को देखें।
- आदेश शुरू करने वाले बटन। एक ग्राफिकल उपयोगकर्ता इंटरफ़ेस में, कुछ बटन आदेश शुरू करते हैं। उदाहरण के लिए, "दबाएँ बाहर निकलें एप्लिकेशन से बाहर निकलने के लिए बटन।
- फ़ील्ड लेबल। कुछ कंप्यूटर टेक्स्ट फ़ील्ड लेबल्स को बोल्ड कर देता है, पर यह सामान्य प्रथा नहीं है क्योंकि इससे हाइलाइटिंग की अतिशयोक्ति हो जाती है। उदाहरण के लिए, इंडेंटेशन डायलॉग बॉक्स के क्षेत्र पर क्लिक करें बायाँ'." अधिक सामान्य यह है कि स्क्रीन पर उपयोग की गई कैप शैली का उपयोग किया जाए। इसे इस तरह लिखना बेहतर है: "डायलॉग बॉक्स के इनडेंटेशन क्षेत्र में, पर क्लिक करें बाएँ."
- आइकन, कीबोर्ड या माउस के बटन। हालाँकि इसे सार्वभौमिक रूप से नहीं अपनाया जाता है, इस प्रणाली का तार्किक पालन करने वाली एक और हाइलाइटिंग तकनीक कीबोर्ड की किसी कुंजी या माउस बटन के नाम को बोल्ड करना है। उदाहरण के लिए, "दबाएँ क्यू कुंजी या बायाँ "माउस बटन।" इस प्रणाली के अनुरूप, आइकॉनों पर बोल्ड का उपयोग भी करना है: "क्लिक करें " शुरू आइकन."
- हार्डवेयर पर लेबल। कंप्यूटर प्रकाशन में एक और सामान्य प्रथा यह है कि हार्डवेयर लेबल के नाम को बोल्ड किया जाता है। उदाहरण के लिए, "दबाएँ रीसेट कंप्यूटर को पुनरारंभ करने के लिए बटन।
आप देखेंगे कि पिछली चर्चा में कोई कठोर नियम नहीं बताए गए थे। ऐसा ही है—तकनीकी प्रकाशन अभ्यास काफी विविध है। मुख्य विचार यह है कि हाइलाइटिंग की एक तार्किक, नियंत्रित प्रणाली विकसित की जाए, उसका लगातार उपयोग किया जाए, और इसे एक शैली मार्गदर्शिका में दस्तावेजीकृत किया जाए ताकि आप और आपकी दस्तावेज़ीकरण टीम के सदस्य इसका संदर्भ ले सकें।
तिरछे अक्षर
यहाँ इटैलिक्स के कुछ मानक उपयोग दिए गए हैं:
- सरल ज़ोर. जैसा कि पहले कहा गया था, सरल जोर देने के लिए बोल्ड या इटैलिक्स के उपयोग को लेकर प्रचलन मिला-जुला है, हालांकि इटैलिक्स परंपरागत रहा है: उदाहरण के लिए, "करें नहीं कंप्यूटर को शटडाउन करने से पहले बंद कर दें। जो भी आप उपयोग करें, उसके साथ सुसंगत रहें, और इसे अपने स्टाइल गाइड या स्टाइल शीट में दस्तावेज़ित करें ताकि आपकी दस्तावेज़ टीम का हर सदस्य इसे देख सके। यदि आपको निश्चित नहीं है कि किसका उपयोग करना है, तो साधारण ज़ोर के लिए इटैलिक्स का उपयोग करें: यह कम व्यस्त दिखता है।
- चर . कंप्यूटर प्रकाशन में, तिरछे अक्षर (इटैलिक्स) का सबसे सामान्य उपयोगों में से एक चर (वेरिएबल) के लिए होता है। उदाहरण के लिए:
कॉपी पुरानी फ़ाइल नई फ़ाइल
उपयोगकर्ता जानते हैं कि उन्हें टाइप नहीं करना चाहिए पुरानी फ़ाइल या नई फ़ाइल लेकिन इसके बजाय अपने स्वयं के फ़ाइल नामों को प्रतिस्थापित करने के लिए। - परिभाषा (दो-स्तंभ) सूचियों में परिभाषाएँ. जबकि दो-स्तंभ सूची में बाएँ स्तंभ के आइटमों के लिए बोल्ड अधिक सामान्य है, इटैलिक्स का भी उपयोग होता है। (बोल्ड पर पिछले खंड में दो-स्तंभ सूचियों की चर्चा देखें।)
- वे शर्तें जिनमें वह पद परिभाषित किया गया हैअच्छा तरीका यह है कि सामान्य मुख्य पाठ में किसी शब्द को परिभाषित करते समय उसे तिरछा (इटैलिक) किया जाए।
अंडरस्कोर्स
तकनीकी पाठ में अंडरस्कोर का उपयोग करने का लगभग कोई कारण नहीं है। टाइप किए गए पाठ के दिनों में यह निश्चित रूप से मौजूद था। हालाँकि, आजकल जब बोल्ड, इटैलिक्स और इस तरह के अन्य टाइपोग्राफिकल प्रभाव आसानी से उपलब्ध हैं, तो अंडरस्कोर पुराने लगते हैं। यदि आप किसी चीज़ पर ज़ोर देना चाहते हैं, तो अपने मानक दिशानिर्देश—उदाहरण के लिए, इटैलिक्स या बोल्ड का उपयोग करें। जोर के स्तर बनाने की कोशिश मत कीजिए: उदाहरण के लिए, इटैलिक्स से लेकर बोल्ड और फिर अंडरस्कोर तक बढ़ती हुई महत्ता का पैमाना आपके पाठकों के लिए समझ से बाहर रहेगा।
यदि आप तकनीकी पाठ में अंडरस्कोर का अच्छा उपयोग देखते हैं, तो यह शायद शीर्षक डिज़ाइन में ही दिखाई देगा।
पूंजीकरण
तकनीकी प्रकाशन में बड़े अक्षरों के उपयोग को लेकर तकनीकी लेखकों और तकनीकी विशेषज्ञों के बीच लगातार संघर्ष सा दिखाई देता है। तकनीकी विशेषज्ञ किसी भी सिस्टम के लगभग हर घटक और प्रक्रिया के नाम के आरंभिक अक्षर बड़े करना पसंद करते हैं। इसके अलावा, तकनीकी विशेषज्ञ (और प्रबंधन) आमतौर पर उस पाठ को पूरी तरह बड़े अक्षरों में लिखते हैं जिसे वे महत्वपूर्ण मानते हैं और जिस पर वे चाहते हैं कि पाठक ध्यान दें। वहीं, तकनीकी लेखक और संपादक (सही तरीके से) केवल उपयुक्त नामों/विशेष संज्ञाओं के लिए ही बड़े अक्षरों के उपयोग पर ज़ोर देते हैं।
एक तकनीकी लेखक के रूप में, बड़े अक्षरों के उपयोग के विरुद्ध दृढ़ रहें। बड़े अक्षर ध्यान भटकाने वाले होते हैं; सभी बड़े अक्षरों वाला पाठ पढ़ने में असुविधाजनक होता है। बड़े अक्षर पाठ को व्यस्त बनाते हैं, जो कई अनावश्यक संकेत भेजते हैं। बड़े अक्षरों का पारंपरिक रूप से उपयोग उपयुक्त नामों के लिए किया जाता है, जैसे Microsoft, Netscape, Gateway, Dell Computers, WordPerfect, आदि। तकनीकी प्रकाशन में क्लासिक दिशानिर्देश यह है कि नामों को बड़े अक्षरों में लिखा जाए। अलग से ऑर्डर किए जा सकने वाले उत्पाद केवल। हालाँकि, संगठनों की राजनीति इस दिशानिर्देश को काफी हद तक मोड़ देती है। यदि किसी कंपनी को अपनी नई रिलीज़ में किसी विशेष फीचर पर गर्व है, उदाहरण के लिए, एनर्जीमाइज़र, तो वह उसका नाम बड़े अक्षरों में लिखेगी, भले ही आप इसे अलग से ऑर्डर न कर सकें।
यहाँ पूंजीकरण से संबंधित कुछ सामान्य दिशानिर्देश दिए गए हैं:
- कंप्यूटर स्क्रीन पर दिखाए गए संदेशों, मेनू या स्क्रीन नामों, फ़ील्ड नामों, हार्डवेयर लेबलों आदि की सटीक कैपिटलाइज़ेशन शैली का उपयोग करें। (काफी पुराने इंटरफेस में फ़ील्ड, मेनू और स्क्रीन नामों जैसी चीज़ों के लिए ऑल-कैप्स का उपयोग किया जाता था। इन मामलों में आम प्रथा यह है कि सामान्य टेक्स्ट में इन चीज़ों के संदर्भों के लिए इनिशियल-कैप्स का प्रयोग किया जाए। यहाँ सिद्धांत यह है कि सामान्य टेक्स्ट में अनावश्यक ऑल-कैप्स ध्यान भंग करने वाले होते हैं।)
- करें नहीं ज़ोर देने के लिए बड़े अक्षरों का उपयोग करें; इसके बजाय तिरछे या मोटे अक्षरों का उपयोग करें।
- किसी भी विस्तारित पाठ के लिए सभी बड़े अक्षरों का उपयोग न करें; उपयोग करें विशेष सूचना प्रारूप इसके बजाय।
- उत्पाद के घटकों या प्रक्रियाओं के नामों को बड़े अक्षरों में न लिखें।
केवल उत्पादों के नामों को बड़े अक्षरों में लिखें, अर्थात् वे घटक जिन्हें अलग से ऑर्डर किया जा सकता है।
उदाहरण के लिए, आपके उत्पाद का नाम WordStuff हो सकता है और निश्चित रूप से इसे मार्केटिंग और उत्पाद योजनाकारों द्वारा बताई गई शैली के अनुसार कैपिटलाइज़ किया जाना चाहिए। हालाँकि, WordStuff की एक विशेषता जिसका नाम "स्पेल चेकर" है, उसे कैपिटलाइज़ नहीं किया जाना चाहिए—क्योंकि लगभग हर किसी के पास ऐसा होता है। हालाँकि, WordStuff में "ZippyFormat" नाम की एक विशेषता और "Image Worker" नाम की एक दूसरी विशेषता हो सकती है। हालाँकि इन्हें अलग से ऑर्डर नहीं किया जा सकता, आप इनके विशेष स्टाइल और उनकी मार्केटिंग मूल्य के कारण प्रारंभिक-अक्षर कैपिटल शैली का उपयोग करना चाहेंगे। "Image Worker" स्पष्ट रूप से ऐसी चीज़ है जिसे WordStuff, Inc. दिखाना चाहता है—इसलिए, कैप्स।
लेकिन जब आपको इस तरह के नियम तोड़ने पड़ते हैं, तो इन अपवादों को शैली मार्गदर्शिका या शैली पत्रक में शामिल किया जाना चाहिए।
एकल या डबल उद्धरण चिह्न
उद्धरण चिह्न अक्सर तकनीकी पाठ में जोर देने की तकनीक के रूप में गलती से उपयोग किए जाते हैं। एक तकनीकी लेखक के रूप में, उद्धरण चिह्नों को पारंपरिक उपयोग तक सीमित रखें, जिसमें उद्धृत भाषण और उन संख्याओं, अक्षरों या शब्दों का उल्लेख शामिल है जिन्हें इसी तरह संदर्भित किया गया हो। उद्धरण चिह्न, बड़े अक्षरों की तरह, पाठ को व्यस्त और ध्यान भंग करने वाला बनाते हैं, इसलिए इन्हें टालना चाहिए।
डबल उद्धरण चिह्नों का एक वैध उपयोग शब्दों के अजीब, विचित्र, गैर-मानक उपयोग के लिए है (जिसे "डराने वाले उद्धरण" द्वारा शिकागो शैली मार्गदर्शिका). उदाहरण के लिए:
कोर डंप में, कंप्यूटर सारा डेटा एक ही फ़ाइल में "उगल देता है".
अच्छी तरह डिज़ाइन किया गया कंप्यूटर टेक्स्ट उद्धरण चिन्हों से काफी हद तक बचता है। मुख्य कारणों में से एक यह है कि कुछ पाठक गलती से यह मान सकते हैं कि उन्हें अपने द्वारा दर्ज किए जाने वाले कमांड में उद्धरण चिन्ह शामिल करना आवश्यक है।
| के बजाय | "मूव" कमांड का उपयोग करें। |
| लिखिए | का उपयोग करें चलना आदेश। |
| के बजाय | दर्ज करें "नकल इंस्टॉल अभी इंस्टॉल करें।" |
| लिखिए | प्रवेश करें कॉपी करें इंस्टॉल करें अभी इंस्टॉल करें |
नोट: हालाँकि कुछ तकनीकी ग्रंथों में एकल उद्धरण चिह्नों के लिए स्पष्ट रूप से परिभाषित उपयोग होते हैं, सामान्यतः पारंपरिक 'उद्धरण के भीतर उद्धरण' नियम और 'विचित्र उपयोग' नियम को छोड़कर एकल उद्धरण चिह्नों का कोई मानक उपयोग नहीं होता। जब आप तकनीकी पाठ में एकल उद्धरण चिह्न देखते हैं, तो आम तौर पर उनके उपयोग के लिए तर्क वह नहीं होता जो डबल उद्धरण चिह्नों के उपयोग के लिए मौजूद हो।
वैकल्पिक फ़ॉन्ट
वैकल्पिक फ़ॉन्ट्स से जुड़ी सबसे आम शैलियों में से एक यह है कि Courier या किसी समान एकसमान-चौड़ाई वाले, पुराने टाइपराइटर-स्टाइल के फ़ॉन्ट का उपयोग मानक बॉडी फ़ॉन्ट (जैसे Times New Roman या Helvetica) के विपरीत किया जाए। आप इस प्रभाव को एक 1web पृष्ठ पर <span class="example_text"> जैसे CSS स्टाइल का उपयोग करके बना सकते हैं। उदाहरण के लिए, "टाइप " स्थापित करें प्रोग्राम को स्थापित करने के लिए।"
यहाँ वैकल्पिक फ़ॉन्टों के सामान्य उपयोगों की समीक्षा है:
- उदाहरण पाठयह संकेत देने के लिए कि दिखाया जा रहा आइटम एक आवश्यक प्रविष्टि के बजाय एक उदाहरण है, अक्सर Courier जैसे वैकल्पिक फ़ॉन्ट का उपयोग किया जाता है:
- प्रदर्शित पाठ. कंप्यूटर और अन्य उपकरण आमतौर पर चेतावनियाँ, स्थिति कोड या त्रुटि संदेश जैसी चीज़ें प्रदर्शित करते हैं। ये मॉनिटर पर या एलसीडी पैनलों और इसी तरह पर दिखाई देते हैं। जब आप इस प्रदर्शित पाठ का उल्लेख करते हैं, तो आप Courier जैसे एक वैकल्पिक फ़ॉन्ट का उपयोग कर सकते हैं। उदाहरण के लिए, "यदि निर्देशिका मौजूद नहीं है, तो सिस्टम प्रतिक्रिया करेगा ऐसी कोई फ़ाइल या निर्देशिका नहीं है." या, "जब कंप्यूटर बूट होता है, डिजिटल रीड-आउट विंडो पर दिखाई देगा 8888."
- विस्तारित कोड उदाहरण. कंप्यूटर प्रोग्रामिंग ग्रंथों में, विस्तृत प्रोग्रामिंग नमूने अक्सर कूरियर फ़ॉन्ट में दिखाए जाते हैं, उदाहरण के लिए:
उदाहरण के लिए, यदि आप किसी फ़ाइल की प्रतिलिपि बनाना चाहते हैं, तो टाइप करें yourfile.txt की प्रतिलिपि बनाएं मेरी फ़ाइल.txt. एक फ़ाइल जिसका नाम है मेरी फ़ाइल.txt बनाया जाएगा, और इसकी सामग्री उसी के समान होगी आपकी फ़ाइल.txt.
|
रंग
तकनीकी पाठ में रंग का उपयोग किया जाता है, लेकिन यह महंगा होता है और प्रकाशन चक्र के दौरान इसे प्रबंधित करना कठिन होता है।
हालाँकि, ऑनलाइन जानकारी में रंग का उपयोग करना आसान है। उदाहरण के लिए, हाइपरटेक्स्ट लिंक अक्सर रंग में दिखते हैं। ऑनलाइन सहायता सामान्यतः हरे रंग का उपयोग करती है, जबकि वेब पेज आमतौर पर नए लिंक के लिए नीले और पहले देखे जा चुके लिंक के लिए बैंगनी का उपयोग करते हैं।
ऑनलाइन जानकारी में रंगों का अनियंत्रित उपयोग करने की प्रवृत्ति बिलकुल उसी तरह है जैसे छपी हुई जानकारी में बोल्ड, इटैलिक्स, फ़ॉन्ट साइज़ और अलग-अलग फॉन्ट्स के साथ बेतहाशा प्रयोग करने की प्रवृत्ति। भावना कुछ ऐसी ही होगी: "यह वहाँ है, यह कूल है, तो चलो इसका इस्तेमाल करते हैं!"
यदि आप रंग का उपयोग करना चाहते हैं, तो इसे सावधानीपूर्वक योजना बनाइए। यह उम्मीद न करें कि पाठक याद रखेंगे कि लाल किसी विचार का संकेत है, नीला किसी अन्य विचार का, और हरा किसी और विचार का। केवल एक रंग पर ही टिके रहें। सामान्यतः, विस्तृत पाठ के लिए रंग के उपयोग से बचें। पूरे चेतावनी नोटिस को लाल बनाने के बजाय, केवल चेतावनी लेबल को लाल बनाइए और चेतावनी का पाठ सामान्य रोमन (मुख्य पाठ जैसा सामान्य टेक्स्ट) में ही रखें।
और भी अच्छा होगा कि तकनीकी संचार के क्षेत्र में रंग पर उपलब्ध कुछ मानक साहित्य पढ़ें। यहाँ सामान्य डिज़ाइन संबंधी मुद्दे और अंतरराष्ट्रीय मुद्दे हैं:
- रंग का उपयोगयू.एस. वेब डिज़ाइन सिस्टम (USWDS) द्वारा प्रदान किया गया।
- विपणन और विज्ञापन में रंग के उपयोग के लिए एक अंतरराष्ट्रीय मार्गदर्शिका. उदाहरण के लिए, लाल रंग के अंतरराष्ट्रीय स्तर पर विभिन्न अर्थ होते हैं। इसके बारे में देखें अंतरराष्ट्रीय रंग प्रतीकात्मकता चार्ट. स्रोत: Six Degrees, LLC
- याद रखें कि, किसी के अनुसार लेख विकिपीडिया में, "लगभग 8% पुरुषों और 0.4% महिलाओं में किसी न किसी तरह का लाल-हरे रंग का अंधापन होता है, चाहे वह एक रंग हो, रंगों का संयोजन हो, या कोई अन्य उत्परिवर्तन।"
उपरोक्त के संयोजन
आम तौर पर, जोर देने की तकनीकों को मिलाना अच्छा विचार नहीं है, उदाहरण के लिए बोल्ड और इटैलिक्स। गैर‑पेशेवर तकनीकी पाठ में, आप ऐसे भद्दे संयोजन देखेंगे जैसे कि सभी अक्षर कैप्स में बोल्ड‑इटैलिक्स या डबल उद्धरण चिह्नों के साथ सभी अक्षर कैप्स में बोल्ड‑इटैलिक्स। इन्हें टालें!
एक वैध संयोजन इटैलिक्स को वैकल्पिक फॉन्ट के साथ उपयोग करना है। उदाहरण के लिए, जब आप किसी कमांड का सिंटैक्स दिखाते हैं, तो आप चाहते हैं कि पूरा टेक्स्ट Courier में हो, लेकिन आप यह भी चाहते हैं कि वेरिएबल इटैलिक्स में हों:
कॉपी पुराना फ़ाइल नाम नई फ़ाइल का नाम
चरित्र शैलियों और टैग्स के लिए कार्यात्मक नाम
यदि आप कभी प्रकाशन उद्योग के आसपास रहे हैं, तो आप शायद किसी ऐसी चीज़ से मिले होंगे जिसे कहा जाता है सार्थक मार्कअप. इसका अर्थ है कि पाठ के अनुभागों को उनके दस्तावेज़—उदाहरण के लिए निभाई जाने वाली संरचनात्मक भूमिका के अनुसार नामित किया जाए, शीर्षक. पाठक इन नामों को नहीं देखता, लेकिन ये दस्तावेज़ के स्वरूपण और इसे पुनः उपयोग करने के तरीके में महत्वपूर्ण भूमिका निभाते हैं।
यह वही विचार पाठ के भीतर वाक्यांशों के शब्दों पर भी लागू होता है। उदाहरण के लिए, वेब पेज के HTML में, आप उपयोग कर सकते हैं <b>बोल्ड किया गया शब्द</b> टैग्स का उपयोग किसी शब्द को बोल्ड करने के लिए किया जाता है। लेकिन बोल्ड शब्द या वाक्यांश के कार्य को इंगित नहीं करता है। इसके बजाय, आदेश होगा या इंटरफ़ेस_लेबल होगा। इसलिए HTML CSS का उपयोग करके सेमांटिक मार्कअप में चीज़ें अधिक कार्यात्मक होती हैं यदि वे इस तरह दिखती हैं: <स्पैन क्लास="कमांड">बोल्ड शब्द</स्पैन>.
HTML और CSS का उपयोग करने वाली फाइलें आम तौर पर अन्य मीडिया में परिवर्तित की जाती हैं, जैसे कि PDF या यहां तक कि XML में और XML से। उपयोग करते हुए कार्यात्मक रूप से नामित हाइलाइटिंग शैलियाँ, जैसा कि ऊपर बताया गया है, रूपांतरण प्रक्रिया को काफी आसान बना सकती हैं।
आगे के अन्वेषण
एक बार आपने उपर्युक्त पढ़ लिया है, अगला अच्छा काम यह है कि आप तकनीकी प्रकाशनों का अन्वेषण करें ताकि यह देखा जा सके कि वे किस प्रकार की हाइलाइटिंग योजनाओं का उपयोग करते हैं। देखें कि बोल्ड, इटैलिक्स, कैप्स, वैकल्पिक फ़ॉन्ट और इस तरह के अन्य प्रभाव कैसे उपयोग किए जाते हैं। अधिकांशतः, आप यहाँ जो पढ़ा है उससे बहुत अलग उपयोग देखेंगे। जैसे‑जैसे आप अन्वेषण करते हैं, उन जोर देने की तकनीकों की तार्किकता के बारे में सोचें जो आप उपयोग होते देख रहे हैं; उन नियमों को संकल्पित करने की कोशिश करें जो लेखकों द्वारा उपयोग किए जा रहे प्रतीत होते हैं; हाइलाइटिंग में असंगतियों पर नज़र रखें; और आप जो उपयोग देख रहे हैं उसके बारे में आलोचनात्मक रूप से सोचें—क्या यह तार्किक है? अतिशयोक्ति है? "अपर्याप्त?"
इस तरह कुछ खोजबीन करने के बाद, अगला तार्किक कदम उस विषय पर अध्याय पढ़ना है। शैली मार्गदर्शिकाएँ, यदि आपने अभी तक ऐसा नहीं किया है। हाइलाइटिंग योजनाओं को स्टाइल गाइडों में दस्तावेज़ीकृत किया जाना चाहिए ताकि आप उन्हें भूल न जाएँ और ताकि आपकी दस्तावेज़ीकरण टीम के सदस्य उनका संदर्भ ले सकें।
हाइलाइटिंग योजना
यदि पहले चर्चा किए गए सभी विकल्पों और वैकल्पिक तरीकों ने आपको अभिभूत कर दिया है, तो निम्नलिखित हाइलाइटिंग योजना का उपयोग करने पर विचार करें। यह उन हाइलाइटिंग तरीकों पर आधारित है जो आप कई UNIX, Windows और Linux दस्तावेज़ों में पाएँगे।
| फ़ील्डों, फ़ोल्डरों, संवादों (बॉक्स), मेनू के नाम (कोई भी इंटरफ़ेस ऑब्जेक्ट जिसे उपयोगकर्ता करते हैं नहीं पर क्लिक करें) | स्क्रीन पर कैप शैली; नियमित रोमन |
| आइकनों के नाम | स्क्रीन पर कैप शैली; बोल्ड |
| बटन (या यदि इन्हें वैसे लेबल नहीं किया गया हो तो कार्यात्मक समकक्ष) | स्क्रीन पर कैप शैली; बोल्ड |
| मेनू चयन, चयन योग्य विकल्प | स्क्रीन पर कैप शैली; बोल्ड |
| कमांड शब्दशः दर्ज किए गए बिना किसी पैरामीटर या फ़्लैग के | साहसी |
| दर्ज किया गया या प्रदर्शित पाठ | कूरियर न्यू (यदि आवश्यक हो, मुख्य फ़ॉन्ट से 1-पॉइंट छोटा आकार) |
| चर | तिरछे अक्षर; सामान्य रोमन |
| प्रोग्रामिंग कोड | कूरियर न्यू; नियमित रोमन; यदि आवश्यक हो, मुख्य फ़ॉन्ट से 1-पॉइंट छोटा आकार |
| हार्डवेयर पर लेबल | Courier New; बोल्ड; यदि आवश्यक हो, बॉडी फ़ॉन्ट से 1-पॉइंट छोटा आकार |
टिप्पणियाँ:
- नियमित रोमन यह मुख्य पाठ के लिए उपयोग किए जाने वाले किसी भी फ़ॉन्ट और फ़ॉन्ट आकार को संदर्भित करता है।
- जबकि ये सुझाव "स्क्रीन पर कैप स्टाइल" की सिफारिश करते हैं, डेवलपर्स कभी-कभी दुर्भाग्यवश सभी अक्षरों को कैप्स में लिखने की प्रवृत्ति रखते हैं। क्योंकि सभी-अक्षरों वाली शैली पठनीयता घटा देती है, फिर भी प्रारंभिक अक्षरों को बड़े रखें (टाइटल केस)।
- यदि आप उपयोगकर्ताओं को उदाहरण टेक्स्ट सहित कोई कमांड कैसे दर्ज करना है यह दिखाते हैं, तो उदाहरण टेक्स्ट में आने वाले कमांड को बोल्ड न करें:
- यदि आप उपयोगकर्ताओं को यह दिखाते हैं कि किसी कमांड को कैसे दर्ज करना है, जिसमें उदाहरण पाठ शामिल हो और उदाहरण पाठ में चर हों, तो उन चर को इटैलिक्स में लिखें।
- यदि आप केवल उस स्क्रीन या मेनू के नाम का संदर्भ दे रहे हैं जिसे क्लिक नहीं किया गया है और जो कोई घटना आरंभ नहीं करता, तो स्क्रीन के लिए कैप स्टाइल और सामान्य रोमन का उपयोग करें।
- कुछ शैलियाँ उस क्रिया को बोल्ड करती हैं जिसे उपयोगकर्ताओं को करना होता है (उदाहरण के लिए, दबाना, प्रवेश करें, हटाएं). यह निश्चित रूप से एक विकल्प है, लेकिन मेरे लिए यह बहुत ज़्यादा हाइलाइटिंग है।
इसका उपयोग करें स्थानांतरित करें फ़ाइल का नाम या स्थान बदलने का कमांड, उदाहरण के लिए:
thisfile.txt का नाम बदलकर thatfile.txt करें.
का उपयोग करें स्थानांतरित करें किसी फ़ाइल के स्थान का नाम बदलने का कमांड:
स्थानांतरित करें मेरी_फ़ाइल.txt आपकी_फ़ाइल.txt.
उपयोगकर्ता मार्गदर्शिकाएँ अक्सर प्रस्तावना में हाइलाइट किए गए फ़ॉन्ट्स, रंगों और टाइपोग्राफी के अर्थों का एक चार्ट रखती हैं:
मैं इस अध्याय के बारे में आपके विचारों, प्रतिक्रियाओं और आलोचनाओं का स्वागत करूंगा: आपका उत्तर.
