मैं एक बढ़ते ओपन सोर्स प्रोजेक्ट का निर्माता हूं। वर्तमान में, मैं प्रलेखन का प्रबंधन करने का सबसे अच्छा तरीका जानने की कोशिश कर रहा हूँ। यहाँ मेरे द्वारा चुने गए विकल्प हैं:
- HTML वेबसाइट
- ए गितुब विकी
- मार्कडाउन फाइलें गिथब पर होस्ट की गईं
- Github README.md में सभी डॉक्स रखना
दस्तावेज़ पहले से ही Markdown में लिखा गया है, मैं अभी यह पता नहीं लगा सकता कि मैं इसे कैसे उपलब्ध करना चाहता हूं। मैं वास्तव में Git की ओर आकर्षित हुआ हूं क्योंकि मैं दस्तावेज़ को शाखा और टैग कर सकता हूं जैसे मैं स्रोत को शाखा और टैग कर सकता हूं।
मैं मार्कडाउन को HTML में अनुवाद करने के लिए मार्कडाउन लाइब्रेरी का उपयोग कर सकता हूं और इसे स्टाइल वेबसाइट पर प्रदर्शित कर सकता हूं। मुझे वेबसाइट में कभी भी कोई बदलाव करने के लिए बदलाव अपलोड करने की आवश्यकता होगी, और प्रलेखन के विभिन्न "टैग" को प्रबंधित करना मुश्किल होगा।
Github Wikis (जहाँ तक मुझे पता है) आप जिस शाखा पर हैं उसके अनुसार नहीं बदलते। इसलिए, मैं किसी भी समय जीथब विकी फॉर्म में प्रलेखन के "मास्टर" संस्करण को ले सकता था।
यह सब Github README में डालना थोड़े साफ-सुथरा है। मुझे ब्रांचिंग और टैगिंग मिलती है, लेकिन यह उपयोग करने के लिए थोड़ा थकाने वाला है और आसान नेविगेशन के लिए अच्छी तरह से उधार नहीं देता है।
मैं कुछ भयानक समाधान याद आ रही है? मेरे पास अन्य विकल्प क्या हैं?