Pecan: दस्तावेज़ीकरण रूपरेखा

@robkooper और @ashiklom ने एक रूपरेखा के आपके दो विचारों को संयोजित करने का प्रयास किया। @KristinaRiemer और @bailsofhay आपकी प्रतिक्रिया प्राप्त करने के लिए अच्छा होगा। इसे जल्द ही लागू करना शुरू करने जा रहे हैं ताकि हम महीने के अंत से पहले पृष्ठों को उस स्थान पर ले जा सकें जहां हम चाहते हैं।

मुझे लगता है कि यह वास्तव में अच्छा लग रहा है। यह सिर्फ मौजूदा सामग्री को पुनर्व्यवस्थित कर रहा है, कुछ भी नहीं जोड़ रहा है?

जब आप ऐसा कर रहे हों, तो अध्याय 41 वास्तव में 40 से पहले जाना चाहिए।

@KristinaRiemer हाँ, मैं बस चीजों को इधर-उधर करने जा रहा हूँ। इस बीच हम उन चीजों की पहचान कर सकते हैं जो गायब हैं और समस्याएं पैदा कर सकते हैं। ध्यान दें कि इसे "महाकाव्य" अंक के रूप में लेबल किया गया है ताकि इन अन्य मुद्दों को इस अंक के तहत जोड़ा जा सके ताकि हम संगठित रह सकें।

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

दस्तावेज़ीकरण के बारे में @infotroph से लिंक: https://www.divio.com/blog/documentation/

दस्तावेज़ीकरण के बारे में @infotroph से लिंक: https://www.divio.com/blog/documentation/

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

• ट्यूटोरियल , शुरुआती लोगों को यह सिखाने के लिए कि आपका टूल चरण-दर-चरण उदाहरणों का उपयोग करके क्या करता है, जो हर बार बताए गए तरीके से काम करने की गारंटी है
• How -tos , कुकबुक अनुभाग जहां उपयोगकर्ता "मैं कैसे करूँ...?" फ़ॉर्म के प्रश्नों के उत्तर देने के लिए जा सकते हैं, जिसमें किसी दिए गए प्रश्न के लिए केवल वे विवरण होते हैं जिनकी उन्हें आवश्यकता होती है।
• संदर्भ , मैन-पेज विवरण के लिए कि चीजों को कैसे कॉल करें, वे कौन से प्रोटोकॉल बोलते हैं, और वे कौन से मूल्य लौटाते हैं
• चर्चा , जहां आप समझाते हैं कि चीजें अपने तरीके से क्यों काम करती हैं, पृष्ठभूमि की जानकारी प्रदान करती हैं, अच्छे बनाम बुरे व्यवहारों पर सलाह देती हैं, और अन्यथा ऐसे संदर्भ देती हैं जो अन्य अनुभागों में फिट नहीं होते हैं।

यह मुद्दा पुराना है क्योंकि यह बिना किसी गतिविधि के 365 दिनों से खुला है।

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