टूलींग पर टिप्पणी।
हमने ऑनलाइन विकी की कोशिश की है, लेकिन कई तरह की सीमाएं पाई हैं, जो व्यक्तिगत स्वाद हो सकती हैं, लेकिन इसमें दस्तावेज़ संरचना शामिल है और सबसे गंभीर रूप से प्रलेखन सर्वर से जुड़ा होना चाहिए।
जुड़ा होना एक गंभीर समस्या है यदि आप या तो ऑफ़लाइन या ऑनसाइट हैं (जाहिर है कि आप सुरक्षित एसएसएल एट अल के साथ ऑनसाइट को कम कर सकते हैं।)
हमारी वर्तमान प्रलेखन प्रक्रिया है:
- स्थिर HTML जनरेटर
- मार्कडाउन सिंटैक्स
- वितरित संस्करण प्रणाली
हमारे पास प्रलेखन के लिए एक 'औपचारिक' लेआउट है और यह मेनू के लिए संरचना प्रदान करता है (और दृश्य स्टाइल के लिए संबंधित सीएसएस आदि)
स्टेटिक HTML जेनरेटर
हम एक घर में स्थैतिक HTML जनरेटर का उपयोग करते हैं जो क्यूबिक्टेम और कई अन्य उपकरणों पर आधारित होता है : pyolution , docutils ।
उत्पन्न पृष्ठ (नहीं?) स्पष्ट रूप से बदसूरत दिख रहे हैं, जैसा कि हम में से अधिकांश / हमारे sysadmins / प्रोग्रामर जानते हैं कि सौंदर्य की दृष्टि से सुंदर क्या है, लेकिन इस तरह के निर्माण में समन्वय की कुल कमी है।
लेकिन यह आर्डर करता है / हम विन्यास फाइल, नमूना स्क्रिप्ट, पीडीएफ़ इत्यादि को शामिल करें, बिना html स्वरूपण के बारे में चिंता किए बिना इसे खराब करने या इसे डाउनलोड करने के लिए 'सर्वर' पर खोजने के बारे में चिंता करें।
यदि यह HTML नहीं है, तो बस इसे फ़ोल्डर में छोड़ दें और इसमें एक यूआरएल लिंक जोड़ें।
HTML लेआउट के लिए 'संभावित' संरचना प्रदान करता है, और गंभीर रूप से ज्ञान / सामग्री आइटम (साथ ही आधार संरचना तंत्र, जैसे मेनू, तालिका की सामग्री आदि बनाने में सक्षम) के बीच 'लिंकिंग' प्रदान करता है, HTML के साथ प्रत्येक उपयोगकर्ता अब कर सकता है। अपनी मशीन पर एक छोटा सा वेब सर्वर चलाएं चाहे लाइटटप या कुछ छोटा हो या बस अपाचे या आईआईएस के साथ पूर्ण उड़ा हो।
हमारे सभी मशीनों में मूल html सेवारत के लिए ग्रंट है, और हमारे लिए पर्याप्त रूप से काम करता है।
मार्क सिंटैक्स।
हम markdown, Textish और या का एक bastardised संस्करण का उपयोग reStructuredTEXT एचटीएमएल के बारे में चिंता किए बिना हमारे 'रचनात्मक' रस प्रलेखन लिख जाने के लिए।
इसका मतलब यह भी है कि हर किसी को अपने पसंदीदा संपादक (मैं विंडोज और * निक्स पर सिंटिला का उपयोग करता हूं) का उपयोग करता हूं, जबकि अन्य यहां vi / vim का उपयोग करते हैं।
वितरित संस्करण प्रणाली।
हम उपयोगकर्ताओं के बीच प्रलेखन को 'वितरित' करने के लिए Git का उपयोग करते हैं । ओह, और हम इसका उपयोग संस्करण क्षमता भी कर रहे हैं।
हमारे लिए मुख्य लाभ यह है कि हम सभी सर्वर से जुड़े बिना प्रलेखन को अद्यतन करने पर काम कर सकते हैं, और बिना इन कार्यों को पूरा किए प्रकाशित नहीं कर सकते हैं। हम सभी प्रलेखन के एक ही हिस्से, या अलग-अलग हिस्सों पर काम कर सकते हैं, या बस जानकारी का उपभोग कर सकते हैं।
निजी तौर पर, मुझे ब्लॉग को अपडेट करने के लिए सर्वर से बंधे होने से नफरत है, अकेले विकी की। गिट हमारे लिए अच्छा काम करता है।
वर्कफ़्लो पर टिप्पणी करना
विकी को ज्ञान प्रसार / संहिताबद्धता के लिए "फैशन" लगता है, लेकिन जैसा कि अन्यत्र टिप्पणी की गई है कि सभी प्रक्रियाओं को बनाए रखना मुश्किल हो जाता है, और ऐसे उपकरणों का मिश्रण खोजना जो आपकी टीमों की जरूरतों का सबसे अच्छा समर्थन करते हैं और टिकाऊ होते हैं, समय लगेगा।
बेहतर समाधान बस खोजा जा रहा है और अनिवार्य नहीं है।
