अब जूते के साथ एक shoemaker, या हम कैसे हमारे अपने शैली गाइड मिला

मुझे लगता है कि, प्रिय पाठकों, आपके काम में आपको तकनीकी दस्तावेज़ीकरण से निपटना पड़ा है और, संभवतः, इसे बनाने वालों के साथ भी - तकनीकी लेखकों के साथ। और हमारे ब्लॉग पर आप वीम टीम के एक तकनीकी लेखक से मिल सकते हैं।

आज हम समझने के अगले स्तर पर चलते हैं कि वीकम सॉफ्टवेयर में तकनीकी दस्तावेज का विकास कैसे होता है।

केडीपीवी धोखा दे रहा है - यह कोई चमत्कार नहीं है, बल्कि अन्य सभी आरएंडडी सहयोगियों के समान काम है। हालांकि, गाइड बनाने वालों के पास गाइड बनाने पर अपने गाइड के लिए जादू शब्द हैं ! यहाँ इस तरह की एक पुनरावृत्ति है।

मेरी सहकर्मी डारिया शालीन की कहानी में और पढ़ें।

नमस्ते, मेरा नाम दशा है और मैं Veeam Software में Content Quality Lead है। मैं हमारी कंपनी के तकनीकी लेखकों विभाग द्वारा बनाई गई सामग्री की गुणवत्ता के लिए जिम्मेदार हूं। व्यवहार में, मैं एक बोतल में एक तकनीकी लेखक और संपादक हूं। मेरी जिम्मेदारियों में शामिल हैं:

• अपनी खुद की परियोजनाएं चलाना - सभी तकनीकी लेखकों की तरह, मेरे पास मेरी जिम्मेदारी का क्षेत्र है, अर्थात्, ऐसे कई उत्पाद हैं जिनके लिए मैं दस्तावेज बनाता हूं और बनाए रखता हूं;
• जूनियर स्तर के कर्मचारियों के लिए प्रशिक्षण - मैंने "शुरुआती" के लिए एक परिचयात्मक पाठ्यक्रम बनाया, जिसे मैं प्रलेखन लिखने के लिए बुनियादी नियमों को समझाने के लिए खर्च करता हूं;
• उच्च स्तर पर कर्मचारियों को सलाह देना (अनुभवी और वरिष्ठ) - मेरे पास दैनिक सत्र निर्धारित हैं, जिसके दौरान हमारी टीम का कोई भी सदस्य मुझसे प्रलेखन के बारे में कोई भी प्रश्न पूछ सकता है (चाहे वह शब्द संरचना, संरचना आदि);
• — , , , .

केवल 3 साल पहले हमारे पास केवल 8 तकनीकी लेखक थे। जब कोई नया आया, तो उसने मौजूदा गाइडों का अध्ययन किया और लगभग एक ही नस में लिखना शुरू किया। यह एक अद्भुत समय था जब हम सभी को सौंदर्य की समान भावना के बारे में पता था, और हम सहजता से एक आम समझ में आ सकते थे कि अपने उत्पादों के लिए दस्तावेज कैसे लिखें।

समय बीतता गया, कंपनी बढ़ती गई, अधिक उत्पाद थे, और तकनीकी लेखकों के कर्मचारियों को बढ़ाने की आवश्यकता थी। आज हम पहले से ही 18 लोग हैं, और हम वहाँ रुकने की योजना नहीं बनाते हैं। सब कुछ ठीक हो जाएगा, लेकिन अचानक यह पता चला कि इतने लोगों के साथ सुंदर पर सहमत होना मुश्किल हो जाता है। इसमें समय, समय और फिर से समय लगता है।

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

यह था:



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

यह बन गया:



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

स्टाइल गाइड के आगमन के साथ, हमने न केवल नए कर्मचारियों को ज्ञान स्थानांतरित करने की प्रक्रिया को सुविधाजनक बनाया, बल्कि निम्नलिखित लाभ भी प्राप्त किए:

• नियमित आधार पर उठने वाले प्रश्नों के उत्तर के लिए थर्ड-पार्टी स्टाइल सरीसृप और इंटरनेट में खोज करने की आवश्यकता को रोकना;
• दस्तावेजों की भाषा, डिजाइन और संरचना के बारे में विवादास्पद मुद्दों का त्वरित समाधान;
• अपने खुद के ज्ञान के आधार के माध्यम से सुविधाजनक नेविगेशन;
• अन्य विभागों के सहयोगियों के लिए विशिष्ट वर्गों को लिंक प्रदान करने की क्षमता, जो प्रत्यक्ष या अप्रत्यक्ष रूप से लेखन ग्रंथों के साथ काम करते हैं (चाहे वह समर्थन या क्यूए हो)।

तकनीकी लेखक के रूप में काम करने के बाद लेखन शैली नाटकीय रूप से कैसे बदलती है, इस बारे में एक प्रसिद्ध मेम।

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

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

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

Veeam तकनीकी लेखन शैली गाइड (अंग्रेजी)