हालाँकि डॉक्स मॉस्को की दूसरी बैठक एक महीने पहले हुई थी, लेकिन रिपोर्ट को प्रकाशित करने और रिपोर्टों के संक्षिप्त सार को प्रकाशित करने में कभी देर नहीं हुई। हम चर्चा करने में सफल रहे, ठीक है, व्यावहारिक रूप से सब कुछ: एक तकनीकी लेखक के पेशेवर प्रक्षेपवक्र के लिए एक प्रतिष्ठित एपीआई दस्तावेज से।
मिताप ने, न केवल "तकनीकी यहूदी बस्ती" को इकट्ठा किया, बल्कि अन्य विशेषज्ञों की एक विस्तृत श्रृंखला को भी इकट्ठा किया, जो परियोजना पर प्रलेखन के साथ एक या दूसरे तरीके से काम करते हैं: टीम के नेता, विश्लेषक, परीक्षक और यहां तक कि एक तकनीकी निदेशक।
हमारी
बैठक 14 अक्टूबर , रविवार को हुई (वह उनके बारे में सबसे लोकप्रिय सवालों में सबसे ऊपर दर्ज हुआ, "रविवार को क्यों?") IPONWEB कार्यालय में। डॉक्स रैलियों को दुनिया भर में बैंगलोर से सैन फ्रांसिस्को, लंदन से सियोल तक आयोजित किया जाता है, समुदाय की रूसी शाखा केवल गतिविधि हासिल कर रही है, लेकिन मॉस्को, सेंट पीटर्सबर्ग और नोवोसिबिर्स्क में पहले से ही शाखाएं हैं।
एंटोन तेलिन, हम वीडियो निर्देश क्यों और कैसे करते हैंवीडियोस्लाइड शोएंटोन VLSI में तकनीकी प्रलेखन विभाग का प्रबंधन करता है, जो एक इलेक्ट्रॉनिक दस्तावेज़ प्रबंधन प्रणाली बनाता है। वीडियो क्यों? लोग निर्देश नहीं पढ़ना चाहते हैं, वे एक समस्या को हल करना चाहते हैं। लोग उन्हें स्पष्ट और स्पष्ट रूप से समझाना चाहते हैं।
वीडियो एक बड़ी मात्रा में जानकारी प्रस्तुत करने, डायनेमिक्स में एक स्क्रिप्ट को लागू करने, क्रियाओं का एक क्रम बनाने का एक सुविधाजनक तरीका है। आप संगीत या डबिंग के साथ उपयोगकर्ता का ध्यान भी आकर्षित कर सकते हैं।
यदि उत्पाद जटिल है और एक अच्छी तरह से सोचा जाने वाला इंटरफ़ेस नहीं है, तो दृश्य भाग के बिना उपयोगकर्ता को इसके सार को बताना मुश्किल है। प्लस यह है कि यह तकनीकी सहायता की लागत को कम करता है।
विपक्ष - सभी प्रकाशन प्रारूपों के लिए उपयुक्त नहीं है, डॉक्टर और पीडीएफ में एम्बेड करना मुश्किल है। इस पर खोज करना कठिन है उच्च गुणवत्ता वाले वीडियो अधिक महंगे हैं।
एक और तत्काल समस्या अद्यतन की जटिलता है, लेकिन एंटोन के अभियान ने इस समस्या को हल किया। उन्होंने उच्च-गुणवत्ता वाले स्क्रीनशॉट के पक्ष में स्क्रीनकेस्ट (स्क्रीन कैप्चर) रिकॉर्ड करने से इनकार कर दिया।
कंपनी दो वीडियो प्रारूपों का उपयोग करती है:
1. वीडियो निर्देश कार्यों का एक अनुक्रम है, विस्तार से और चरणों में। अवधि ~ 2 मिनट। 1 निर्देश 1 समस्या है। यह सभी विंडो, जैकडॉ, बटन के बारे में बात नहीं करता है। फिर डबिंग, बैकग्राउंड म्यूजिक, टेक्स्ट एक्सप्लेनेशन, कैप्शन जोड़े।
2. व्याख्यात्मक वीडियो। यह उत्पाद निर्देश और प्रस्तुति के जंक्शन पर कुछ है। तकनीकी विवरण के बिना एक सामान्य दृश्य कई समस्याओं या परिदृश्यों को हल करता है। इस वीडियो में लोग और एनीमेशन शामिल हो सकते हैं। अवधि 2-3 मिनट।
उपकरण: संपादन के लिए एडोब प्रीमियर और एडोब आफ्टर इफेक्ट, एडिटिंग के लिए साउंड, फोटोशॉप और स्नैगिट के लिए एडोब ऑडिशन। परियोजना को कई स्क्रीनशॉट्स से इकट्ठा किया गया है, जो प्रासंगिक या गलत नहीं हैं फिर इसे बदलना आसान है। अगला, माउस, एनीमेशन, ध्वनि के आंदोलन को आकर्षित करना।
उन्होंने डबिंग के लिए गैर-पेशेवर उद्घोषकों का उपयोग करने का फैसला किया, क्योंकि वे बहुत औपचारिक लग रहे थे, इसलिए वे कंपनी के एक कर्मचारी इल्या की आवाज का उपयोग करते हैं, जो एक मेटलकोर समूह में गाते हैं। जानकारी के ब्लॉक के बाद, समझ के लिए 2 सेकंड का ठहराव दिया जाता है।
वीडियो आपके स्वयं के होस्टिंग और Youtube पर दोनों प्रकाशित किए जाते हैं। नकारात्मक पक्ष इसे कई कंपनियों द्वारा सुरक्षा कारणों से अवरुद्ध कर रहा है।
बेशक, वीएलएसआई सभी उपलब्ध आंकड़े एकत्र करता है: औसत देखने का समय, पसंद, तकनीकी समर्थन कॉल जो वीडियो लिंक का उपयोग करके बंद कर दिए गए थे।
निकोले वोल्किन, तकनीकी लेखक संस्करण 2.0.1वीडियोस्लाइड शोयह SECR सम्मेलन की रिपोर्ट के अतिरिक्त एक दोहराव या बेहतर कहा गया है। निकोलाई ने लंबे समय तक तकनीकी लेखकों को देखा और ध्यान दिया कि वे हमेशा यह नहीं जानते कि उनके लाभों को कैसे औचित्य और मापना है, और जो नेता उन्हें कार्य भी निर्धारित करते हैं।
कुछ संबंधित कार्य हैं जिन्हें तकनीकी लेखक हल कर सकते हैं। निकोले ने कहा कि कैरियर के प्रक्षेपवक्र और कौशल सेट में तकनीकी विवरण हैं, व्यवसाय को अपने नए कार्यों को कैसे बेचना है।
5 भूमिकाएँ जो एक तकनीकी लेखक निभा सकता है:
1.
डोकॉप्स - डॉक्यूमेंटेशन के लिए लेखक, लेखक / प्रोग्रामर, वह जनरेशन को ऑटोमेट कर सकता है, डॉक्यूमेंटेशन, डॉक्यूमेंटेशन अपलोड कर सकता है, टीम को इसके साथ काम करने की ट्रेनिंग देता है और इसके आसपास की सभी प्रॉसेस को रिकवर करता है।
लाभ कम हो जाते हैं श्रम श्रम, संसाधन बचत और सुविधा वितरण की गति अधिक होती है।
2.
यूएक्स लेखक - इंटरफेस में ग्रंथों को लिखने में एक विशेषज्ञ।
लाभ - डिजाइनर, कविताएं, विश्लेषक या फ्रंट-एंड डेवलपर्स हमेशा यह नहीं समझते हैं कि कैसे सही ढंग से लिखना है, उपयोगकर्ता को फ़ंक्शन, बटन, संक्रमण कैसे पहुंचाएं। ग्रंथ इस सिद्धांत के अनुसार लिखे गए हैं कि कौन पहले उठा और चप्पल। इंटरफ़ेस की सुविधा, तकनीकी सहायता के लिए समय कम करना।
3. एक
तकनीकी प्रचारक , वह प्रौद्योगिकी के बारे में बात करता है, समुदाय के साथ बातचीत करता है, उसे आकार देता है।
लाभ - उत्पाद के प्रति कंपनी का विश्वास और निष्ठा बढ़ी, काम पर रखने का सरलीकरण, एचआर ब्रांड।
4.
नॉलेज मैनेजर - यह पता लगाता है कि एक कंपनी ज्ञान का उत्पादन, भंडारण और स्थानांतरण कैसे करती है। इन प्रक्रियाओं को स्थापित करता है ताकि ज्ञान लीक न हो।
लाभ - कम बस कारक, कर्मचारियों के अनुकूलन की गति, दोनों शुरुआती और संक्रमण के दौरान, ज्ञान का पुन: उपयोग, जोखिम में कमी।
5.
डॉक्यूमेंटेशन ओनर - पीएम और डॉक्यूमेंटेशन एनालिस्ट। वह दस्तावेज़ीकरण में संचार और उपयोगकर्ता बातचीत की पूरी प्रणाली का निर्माण करता है।
समर्थन लागत को कम करने में लाभ फिर से है।
चर्चा के दौरान, हमने कंटेंट मैनेजर के रूप में ऐसी एकीकृत भूमिका को याद किया, जो रिपोर्ट में नोट नहीं की गई थी।
कॉन्स्टेंटिन वलेव, फोलिएंटवीडियोस्लाइड शोरेस्ट्रिम से कॉन्स्टेंटाइन ने
फोलिएंट टूल के बारे में बात की - मार्कडाउन भाषा पर आधारित डॉप्स वर्कफ़्लो का कार्यान्वयन। एक साल पहले,
यैंडेक्स में मिनी-हाइपरबेटन के हिस्से के रूप
में, कॉन्स्टेंटिन ने पहले से ही फोलिएंट के बारे में बात की थी, और तब से बहुत कुछ बदल गया है।
दस्तावेज़ीकरण एमडी फ़ाइलों में लिखा गया है, और विभिन्न स्थानों में झूठ बोल रहा है, उपकरण निरंतर एकीकरण, स्वचालित विधानसभा का समर्थन करता है, और यह आपको अपनी पसंद के अनुसार एमडी का विस्तार करने की भी अनुमति देता है।
आवश्यकताएँ: आपको अच्छी टाइपोग्राफी वाले ग्राहकों और पीडीएफ के लिए डॉक्स देने की जरूरत है, मानव-पढ़ने योग्य स्रोत (एक्सएमएल नहीं)।
हुड के तहत, एक सार्वभौमिक पंडोक कनवर्टर का उपयोग किया जाता है, पायथन, बैश स्क्रिप्ट शीर्ष पर घाव हैं। लेकिन समय के साथ, लिपियों की संख्या बढ़ती गई, इसलिए उन्हें एक एकल, अखंड आवेदन में फिर से लिखा गया।
मोनोलिथ से, फिर उन्होंने असेंबली को नियंत्रित करने वाले कर्नेल के साथ एक मॉड्यूलर संरचना बनाई, प्रीप्रोसेसर जो कोडांतरकों के काम के लिए एमडी को परिवर्तित करते हैं, और स्वयं कोडांतरक।
फोलिएंट अनिवार्य रूप से अच्छे साधनों (mkdoc, pandoc, slate, latex) के बीच का गोंद है। अब वे यह सिखाने की कोशिश कर रहे हैं कि विभिन्न प्रारूपों से प्रलेखन स्रोतों का उपभोग कैसे किया जाए।
प्रोजेक्ट फ़ोल्डर में अंतिम दस्तावेज़, शैलियों और वास्तविक एमडी फ़ाइलों की संरचना के साथ एक कॉन्फिगरेशन है, फिर प्रीप्रोसेसर स्रोत एमडी फ़ाइलों को लेते हैं और सभी एमडीएम की शैली में वांछित एमडी बनाने के लिए उन पर प्रसंस्करण लागू करते हैं (फ़ॉलेन्ट की शैली में एमडी), फिर अंतिम दस्तावेजों के संग्रहकर्ता ( pandoc, mkdoc) उन्हें लक्ष्य (दस्तावेज) बनाते हैं। एमडी असेंबली के बाद, सिंटैक्स की जांच के लिए लिंटर चलाया जाता है। बिल्ड या बग के बारे में सूचनाएँ भी भेजी जाती हैं।
यह सब डॉकर में एकत्र किया जा सकता है, ताकि सभी पैकेजों को एक तरीके से वितरित किया जा सके, और प्रत्येक को अलग से नहीं।
फोलिएंट एडवांस्ड सपोर्ट में शामिल हैं, गीतालाब / गितुब से कोड के टुकड़े निकाल सकते हैं और सिंपली से लेआउट वाले चित्र, आरेख, पाठ में स्थानापन्न पैरामीटर, सशर्त विवरण खींच सकते हैं।
निकिता समोखवेलोव, रेस्टफुल एपीआई पर व्यापक प्रलेखनवीडियोस्लाइड शोनिकिता के तकनीकी निदेशक, निकिता समोखवालोव ने बताया कि कैसे उन्होंने ओपन एपीआई 3.0 के आधार पर एपीआई प्रलेखन की पीढ़ी को कॉन्फ़िगर किया।
बाकी सभी की तरह, उन्होंने Google डॉक्स के साथ शुरुआत की, लेकिन इसमें न तो संस्करण है और न ही शाखाएं बनाने की क्षमता है। फिर उन्होंने सिर्फ रिपॉजिटरी में एमडी फाइलें लिखना शुरू कर दिया, शाखाओं को बनाने और बनाने की समस्या हल हो गई, लेकिन सब कुछ धीमा था। फिर ऑटो-जनरेशन में आए।
प्रलेखन की निम्नलिखित आवश्यकताएं थीं: प्रलेखन के टुकड़ों का उत्तराधिकार और पुन: उपयोग, मापदंडों और विधियों के विवरण के लिए एक लिंक प्रदान करने की क्षमता, एक्सेस अधिकारों के भेदभाव के बारे में जानकारी, कोड के रूप में प्रलेखन (तुल्यकालिक तैनाती और परिवर्तन)। इसके अलावा, प्रलेखन केवल आपकी टीम और स्नातक विकास टीमों के लिए सार्वजनिक रूप से प्रकाशित नहीं किया जाता है।
हमने ओपनएपीआई 3.0 विनिर्देश चुना। क्यों? यह सबसे ताज़ा है, यह अधिक सुविधाओं का समर्थन करता है, हालांकि अभी भी इसके चारों ओर एक छोटा सा पारिस्थितिकी तंत्र और विशेषज्ञता है।
उन्होंने
शिंस टूल लिया (प्रश्नों के उदाहरणों, विधियों, मापदंडों के विवरण), विडेरशिन (यामल / जसन से लेकर एमडी कनवर्टर तक) के साथ एक सुंदर लैंडिंग पृष्ठ में दिखाया गया है, उन्होंने अपना स्वयं का
स्पेक्टर पैकेज भी लिखा है (सभी आवश्यक निर्भरताएं स्थापित करता है, npm के माध्यम से काम करता है, चेक भी करता है) फ़ाइल आवंटन संरचना की शुद्धता)।
पर्यावरण की स्थापना और सांत्वना में एक ही लाइन पर प्रलेखन का काम किया जाता है। फाइलें जो प्रत्येक परियोजना में पुन: उपयोग करने की आवश्यकता होती हैं, उदाहरण के लिए, एक प्राधिकरण विवरण, निर्भरता / फ़ोल्डर में आते हैं।
निकिता ने इस बारे में भी बात की कि वे एक वितरित टीम में शाखाओं के साथ कैसे काम करते हैं, जब कार्य को अद्यतन करने के लिए है और निश्चित रूप से, ओपनएपीआई 3.0 के कार्यान्वयन के साथ आने वाले नुकसान और कठिनाइयों के बारे में।
स्वेतलाना नोविकोवा, ज्ञान प्रबंधन का उपयोग कर योग्यता मैट्रिक्सवीडियोस्लाइड शोस्वेतलाना (वैसे, यह मैं हूं) ने इस बारे में बात की कि कंपनी में उन्होंने एंड-टू-एंड इंस्ट्रूमेंट के रिबूट की व्यवस्था कैसे की है, कार्मिक प्रबंधन से एक सक्षमता मैट्रिक्स के रूप में है, इस तरह से ज्ञान प्रबंधन का उपयोग क्या है, कैसे साधन बस कारक को कम करने में मदद करता है, नए लोगों को बोर्ड करना बेहतर है, यहां तक कि भागों को भी ढूंढें। रिफैक्टरिंग के लिए कोड।
दानिला मेदवेदेव, न्यूरोकोडवीडियोडैनिला ने एक ऐसे उपकरण के बारे में बात की जो हर किसी के लिए समझ में आता है, और शायद हमारे समय से आगे, न्यूरोकोड नामक मॉडलिंग और भंडारण ज्ञान के लिए।
यह उपकरण आईटी सिस्टम के डिजाइन में शामिल किसी के लिए भी उपयोगी है। विशेष रूप से, दानिला दस्तावेज़-आधारित प्रणालियों को छोड़ने का सुझाव देता है। किसी भी प्रणाली को एक नेटवर्क के रूप में माना जाता है, जिसके नोड्स के अनुसार कुछ जानकारी प्रसारित होती है। सिस्टम के सभी तत्व इस सिद्धांत का पालन करते हैं - अपडेट अपडेट, डॉक्यूमेंट ट्रांसफर, फीडबैक ट्रांसफर। न्यूरोकोड का उद्देश्य "सहायक प्रक्रियाओं के लिए अनुत्पादक लागत को कम करना और संगठन की सामूहिक बुद्धि को मजबूत करना है"।
न्यूरोकोड परियोजना समस्या को हल करने से बढ़ी - कैसे एक टीम के लिए या खुद के लिए जानकारी का एक अच्छा भंडार बनाने के लिए, कैसे जानकारी का एक मॉडल बनाने के लिए। सिस्टम का प्रोटोटाइप बनाया और काम करता है, अब सिस्टम इंजीनियरों और बिजनेस आर्किटेक्ट की मदद से इसका परीक्षण किया जा रहा है। सिस्टम में एक स्केलेबल इंटरफ़ेस है और यह एक भग्न डेटा संरचना पर आधारित है। यह 1960 के दशक के ओपन हाइपर-डॉक्यूमेंट सिस्टम (OHS) के बारे में डगलस एंगेलबर्ट (मानव मशीन इंटरफेस पर पहले शोधकर्ताओं में से एक है, जो GUI, हाइपरटेक्स्ट आदि की अवधारणाओं के लेखक हैं) पर आधारित है, जब सिस्टम दस्तावेज़-आधारित नहीं है, लेकिन एक एकल , अर्थात्, यह मानव गतिविधि की सभी प्रक्रियाओं को लागू करता है।
PS सामान्य तौर पर, बेहतर वीडियो देखें।
अगली बैठक,
डॉक्स मॉस्को लिखें, 7 दिसंबर को पॉजिटिव टेक्नोलॉजीज के कार्यालय में होगी, और इसे पॉजिटिव ऑथरिंग टूल्स बैटल के प्रारूप में आयोजित किया जाएगा।
