सवाल आप अपने काम, प्रक्रियाओं और पर्यावरण को कैसे दस्तावेज कर रहे हैं?


क्या आप विकी प्रारूप का उपयोग कर रहे हैं? यदि हां, तो कौन सा उत्पाद? (मीडियाविकि, संगम, शेयरपॉइंट इत्यादि)

क्या आपने ज्ञान आधार बनाया है? (समस्या / समाधान उन्मुख लघु दस्तावेज।)

काम करने वाले दस्तावेज बनाने के साथ आपको क्या चुनौतियां मिलती हैं, इसलिए जब आप छुट्टियों पर उतरते हैं तो आपको कॉल नहीं मिलता है?

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

अद्यतन करें

उत्तर अब तक शामिल हैं

  •  संगम हे
  •  Flexwiki
  •  FogBugz
  •  मीडियाविकी (फ़ेकेडिटर जैसे प्लगइन्स के साथ)
  •  शेयर बिंदु
  •  TWiki
  •  शब्द / एक्सेल / Visio डॉक्स
  •  दस्तावेज स्क्रिप्ट्स

संपादित करें: क्या आप अपनी निगरानी प्रणाली के साथ अपने नेटवर्क को पूरी तरह से दस्तावेज नहीं कर रहे हैं? Nagios हमेशा के उपयोग को प्रोत्साहित किया है माता-पिता अपने नेटवर्क की संरचना को प्रतिबिंबित करने का निर्देश, और notes_url निर्देश आपको विकी या अन्य ब्राउज़र-आधारित दस्तावेज़ों से लिंक करने की अनुमति देने के लिए डिज़ाइन किया गया है। तो यहां "प्रलेखन" निगरानी प्रणाली के "जीवित दस्तावेज़" और विकी में अधिक विस्तृत, ऑफ़लाइन दस्तावेज़ों के बीच विभाजित है। चूंकि मैं नागियोस में बहुत समय बिताता हूं, इसलिए इसे यथासंभव जानकारीपूर्ण बनाने में प्रयास करना समझ में आता है।


48
2018-06-04 04:59


मूल


आपके प्रश्न ने अभी स्लैशडॉट बनाया है tech.slashdot.org/article.pl?sid=09/05/25/2154237 - username
हेहे :) काश मैं किसी भी तरह से इस सवाल को समाप्त कर सकता हूं, शायद बीटा के खत्म होने की प्रतीक्षा करें ... - Cawflands
साइडबार में "संबंधित" खंड देखें - serverfault.com/questions/3970/... हो सकता है कि आप क्या खोज रहे हैं - Olaf
मॉनिटरिंग सिस्टम जैसे नागोस आपको बताते हैं कि वर्तमान में आपके नेटवर्क / सिस्टम कैसा दिखते हैं। वे आम तौर पर आपको नहीं बताते हैं कि वे नेटवर्क और सिस्टम क्यों स्थापित कर रहे हैं। - David


जवाब:


टूलिंग पर टिप्पणी कर रहा है।

हमने ऑनलाइन विकी की कोशिश की है लेकिन कई सीमाएं पाई हैं, जो व्यक्तिगत स्वाद हो सकती हैं, लेकिन दस्तावेज़ संरचना शामिल हैं और सबसे गंभीर रूप से दस्तावेज़ीकरण सर्वर से जुड़ना है।

कनेक्ट होने पर एक गंभीर समस्या है यदि आप ऑफ़लाइन या ऑनसाइट हैं (जाहिर है आप एक सुरक्षित एसएसएल कनेक्शन आदि के साथ ऑनसाइट को कम कर सकते हैं।)

हमारी वर्तमान दस्तावेज़ीकरण प्रक्रिया है:

  • स्थिर एचटीएमएल जनरेटर
  • मार्कडाउन वाक्यविन्यास
  • वितरित संस्करण प्रणाली

हमारे पास प्रलेखन के लिए 'औपचारिक' लेआउट है और यह मेन्यू के लिए संरचना प्रदान करता है (और दृश्य स्टाइल आदि के लिए संबंधित सीएसएस)

स्टेटिक एचटीएमएल जेनरेटर

हम घर पर स्थिर एचटीएमएल जेनरेटर के आधार पर उपयोग करते हैं cubictemp और कई अन्य टूल्स: pygments, docutils

जेनरेट किए गए पृष्ठ स्पष्ट रूप से बदसूरत दिख रहे हैं (क्योंकि?) हम में से अधिकांश / हमारे सिसडमिन / प्रोग्रामर जानते हैं कि सौंदर्यपूर्ण रूप से सुंदर क्या है लेकिन इस तरह के निर्माण में समन्वय की कुल कमी है।

लेकिन यह हमें विन्यास फाइलों, नमूना स्क्रिप्ट्स, पीडीएफ इत्यादि को शामिल करता है, बिना एचटीएमएल स्वरूपण के बारे में चिंता किए बिना या इसे डाउनलोड करने के लिए 'सर्वर' पर कहां ढूंढना है इसके बारे में चिंता किए बिना।

यदि यह HTML नहीं है, तो बस इसे फ़ोल्डर में छोड़ दें और इसमें एक यूआरएल लिंक जोड़ें।

एचटीएमएल लेआउट के लिए 'संभावित' संरचना प्रदान करता है, और समीक्षकों से ज्ञान / सामग्री वस्तुओं के बीच 'लिंकिंग' प्रदान करता है (साथ ही बेस स्ट्रक्चर मैकेनिज्म, जैसे मेन्यू बनाने में सक्षम होने, सामग्री की तालिका इत्यादि) एचटीएमएल के साथ, प्रत्येक उपयोगकर्ता अब कर सकता है अपनी मशीन पर एक छोटा सा वेब सर्वर चलाएं चाहे वह lighttpd या कुछ छोटा हो या अपाचे या आईआईएस के साथ पूरी तरह से उड़ा जाए।

हमारी सभी मशीनों में मूल HTML सेवा के लिए गड़बड़ी है, और हमारे लिए काफी अच्छी तरह से काम करता है।

मार्कडाउन वाक्यविन्यास।

हम मार्कडाउन, टेक्स्टिश और या बर्स्टर्ड संस्करण का उपयोग करते हैं reStructuredTEXT हमारे 'रचनात्मक' रस एचटीएमएल के बारे में चिंता किए बिना दस्तावेज लिखने के लिए।

इसका मतलब यह भी है कि हर किसी को अपने पसंदीदा संपादक का उपयोग करना है (मैं विंडोज़ और * निक्स पर स्किंटिला का उपयोग करता हूं) जबकि अन्य लोग यहां vi / vim का उपयोग करते हैं।

वितरित संस्करण प्रणाली।

हम प्रयोग करते हैं Git उपयोगकर्ताओं के बीच प्रलेखन 'वितरित' करने के लिए। ओह, और हम इसकी संस्करण क्षमता का भी उपयोग करते हैं।

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

व्यक्तिगत रूप से, मुझे ब्लॉग अपडेट करने के लिए सर्वर से बंधे होने से नफरत है, विकी के अकेले रहने दें। गिट हमारे लिए अच्छा काम करता है।

वर्कफ़्लो पर टिप्पणी कर रहा है

विकी ज्ञान प्रसार / कोडिफिकेशन के लिए "फैशन" प्रतीत होता है, लेकिन जैसा कि कहीं और टिप्पणी की गई है, सभी प्रक्रियाओं को बनाए रखना मुश्किल हो जाता है, और उन उपकरणों के मिश्रण को ढूंढना जो आपकी टीमों की सर्वोत्तम आवश्यकताओं का समर्थन करते हैं और टिकाऊ समय लेते हैं।

बेहतर समाधान सिर्फ खोजे जा रहे हैं और अनिवार्य नहीं हैं।


8
2018-06-04 05:55



मैं उपयोग करता हूं ikiwiki गिट के शीर्ष पर। मुझे मार्कडाउन और डिसकनेक्टेड ऑपरेशन भी देता है - ptman


हमने उपयोग करना शुरू कर दिया है DokuWiki जहाँ मैं काम करता हूँ।

डोकुविकी की वेबसाइट से:

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

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


7
2018-05-04 13:31





डोकू विकी या चार्ट में फिट होने वाली अन्य चीजों के लिए शेयरपॉइंट।

आप विकी पर पोस्ट करने के लिए बहुत तेज़ी से उपयोग करते हैं और वाक्यविन्यास वास्तव में इतना जटिल नहीं है। जानकारी व्यवस्थित करना बहुत आसान है और बाद में इसे किसी अन्य व्यक्ति द्वारा ढूंढना आसान बनाता है।

मैं स्पष्ट स्पष्टीकरण (जेपीईजी के रूप में निर्यात) के लिए ग्राफ बनाने के लिए visio का उपयोग करें।


6
2018-05-04 13:53





हम एक विकी का उपयोग कर रहे हैं। वास्तव में, हम मीडियाविकि का उपयोग कर रहे हैं। मीडियाविकि के शीर्ष पर, हमारे पास है अर्थपूर्ण मीडियाविकि विस्तारस्थापित, जो वास्तव में हमारे मीडियाविकि को एक ढीले टाइप किए गए डेटाबेस में बदल देता है जिसे हम श्रेणी, शीर्षक, सामग्री इत्यादि से पूछ सकते हैं।

उदाहरण के लिए, मान लीजिए कि मैं क्लस्टर एफ के माध्यम से रूट करने वाले सभी नेटवर्क नामों को देखना चाहता हूं। मुझे बस इतना करना है कि विशेष प्रश्न पूछें [[श्रेणी: cname]] [[destination :: cluster_f]] .. और यह उन सभी पृष्ठों को वापस कर देगा जिन्हें क्लस्टर_एफ के रूप में गंतव्य के साथ एक नाम के रूप में वर्गीकृत किया गया है।

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


6
2018-05-04 14:04





सही प्लगइन्स के साथ, Trac एक संयोजन टिकट और विकी प्रणाली बन सकते हैं। यह आपके टिकटों के लिए विकी लेखों और इसके विपरीत से लिंक करना आसान बनाता है।

मुझे पसंद है कुछ प्लगइन्स:

  • निजी टिकट प्लगइन। ट्रैक एक बगबेस के रूप में बनाया गया है जहां सभी टिकट और उनके जवाब सार्वजनिक हैं। यह एक आईटी टिकट प्रणाली के लिए उपयुक्त नहीं है, लेकिन यह प्लगइन इसे हल करता है।
  • Trac WYSIWYG प्लगइन। आइए इसका सामना करते हैं, ज्यादातर लोग आपको खुश करने के लिए विकिसिंटाक्स सीखने वाले नहीं हैं। इससे उन्हें टिकट और विकी पृष्ठों दोनों के लिए एक 'जो आप देखते हैं वह आपको मिलता है' संपादक देता है।

यहां काफी संख्या में उपलब्ध हैं अधिक Trac के लिए अनुकूलन। अपनी पसंद के लिए एक ट्रैक सिस्टम सेटअप और अनुकूलित करना मुश्किल नहीं है!


6
2018-05-04 13:29



इसे +1 करें। न केवल ट्रैक की विकी दस्तावेज़ों के लिए आसान पढ़ने और संपादन करता है। कॉन्फ़िगरेशन वर्जनिंग के लिए इश्यू टिकटिंग और एसवीएन के साथ उपयोग किए जाने पर, आपके पास पूरे वर्कफ़्लो की सहज दृश्यता है। - Dan Carley


मेरे पिछले काम में मैंने ट्विकी का इस्तेमाल किया था। यह काफी अच्छी तरह से काम किया।

उसके आगे, मैं अधिकतर कार्यों को स्वचालित करता हूं, और स्क्रिप्ट को दस्तावेज करता हूं (हमेशा उत्साह के साथ नहीं, लेकिन फिर भी ...)। दस्तावेज स्क्रिप्ट आसानी से उन्हें डिजाइन करने की प्रक्रिया में किया जाता है, इसलिए कोई असली ओवरहेड नहीं ...

दोनों (और स्क्रिप्ट के लिए संस्करण नियंत्रण का उपयोग) के संयोजन ने चाल को काफी अच्छी तरह से किया।


5
2018-06-04 05:13





जिरा, संगम और शब्द दस्तावेज़ों का मिश्रण।


5
2018-05-04 13:45





ज्ञान को संस्थागत बनाना

हमने दस्तावेजों से शुरुआत की। फिर हमने उनमें से कुछ को शेयरपॉइंट पुस्तकालयों में संग्रहित किया। फिर हाल ही में हम शेयरपॉइंट विकी में चले गए। मुझे विकी के कम-घर्षण दृष्टिकोण को जल्दी से अपडेट करने में पसंद है, हालांकि शेयरपॉइंट की विकी कुछ चीजों को ग्राफिक्स समर्थन और टेबल जैसी चीजों के लिए स्वरूपण समर्थन में वांछित छोड़ देती है। टेक्स्ट के लिए यह ठीक है और अंतर्निहित संपादक कुछ बुनियादी HTML प्रारूपण और आदेशित / अनियमित सूचियों की अनुमति देता है। शेयरपॉइंट के लिए अन्य कम लागत वाले विकल्प हैं।

हमारे सहायता डेस्क सॉफ़्टवेयर, नुमारा के ट्रैक-इट में हमारे समर्थन टिकटों के लिए हमारे पास अनौपचारिक ज्ञान आधार भी है। यह सही नहीं है लेकिन यह काम करता है।

संस्थागत ज्ञान का उपयोग करने के लिए कर्मचारियों को प्राप्त करना

मैं आपके मूल्यांकन से सहमत हूं कि संस्थागत ज्ञान प्राप्त करना युद्ध का केवल एक हिस्सा है। यदि आपके संगठन और लोगों का उपयोग "पहले शोध करने के लिए नहीं किया जाता है, तो दूसरा पूछें" तो आप पाएंगे कि पुराना तरीका प्रचलित है: हर कोई अभी भी उत्तर के लिए औपचारिक और अनौपचारिक गुरुओं को देखेगा, और कुछ लोगों के लिए यह पूछना आसान होगा अपने आप को खोजने के बजाय आपके आगे वाला व्यक्ति।

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

बस कुछ विचार: शायद औपचारिक नीति के रूप में प्रोत्साहित करने की आवश्यकता होगी जिसमें कहा गया है कि हल किए गए टिकटों और मुद्दों को ज्ञान आधार या विकी में दस्तावेज करने की आवश्यकता है, जिन्हें उन्हें बंद माना जा सकता है। इसके अलावा, ज्ञान के नेताओं जो आम तौर पर पूछे जाने वाले प्रश्न पूछते हैं, हमेशा अनुरोध पर उत्तर नहीं देना चाहिए; उन्हें लोगों को विकीज़ को इंगित करने की आवश्यकता होती है और उन्हें पहले वहां जांचने के लिए उपयोग किया जाता है। एक और बात यह है कि उपयोगकर्ताओं को स्वयं सहायता के लिए डेटा उपलब्ध कराया जाए ताकि समस्या को संभावित रूप से हल किया जा सके, इससे पहले कि तकनीकी कर्मचारियों को एक और आइटम मिल जाए।

हमारे हेल्प डेस्क सिस्टम के लिए स्टैक ओवरफ्लो और सर्वरफॉल्ट के समान सिस्टम होना अच्छा होगा: जब कोई प्रश्न टाइप करते हैं, तो खोज इंजन को समान आइटम मिलते हैं और उन्हें ऑफ़र करते हैं, इसलिए उपयोगकर्ता प्रश्न सबमिट करने से पहले भी उन्हें देख सकते हैं।


5
2018-06-04 05:46



+1: जहां मैं काम करता हूं, कर्मचारियों को संसाधनों का उपयोग करने के लिए यह एक समान समस्या थी, विशेष रूप से, यह समस्याएं देखने के लिए समस्या ट्रैकिंग सिस्टम का उपयोग कर रही थी। मैंने उन लोगों को ले लिया जो मुझे अपनी मेज पर पहली बार दोबारा बाधित करने और उनके साथ एक नया बग टिकट भरने में अपनी परेशानी बदलने में परेशानी थी। 2 महीने लग गए और अब हर कोई अपनी खुद की बग में प्रवेश करता है और वे सभी को ध्यान में रखा जाता है। एक समान दृष्टिकोण यहां उपयोगी हो सकता है (यानी उनके साथ [सिस्टम] में प्रश्न में दस्तावेज़ की तलाश करें) - Steven Evers