PHP
PHP मेनुअल में योगदान देना

codeigniter HTML JavaScript jQuery Laravel MySQL Regular Expressions SQL symfony2 WordPress

परिचय

PHP मैनुअल एक कार्यात्मक संदर्भ और PHP संदर्भ की प्रमुख विशेषताओं के स्पष्टीकरण के साथ एक भाषा संदर्भ दोनों प्रदान करता है। PHP मैनुअल, अधिकांश भाषाओं के प्रलेखन के विपरीत, PHP डेवलपर्स को प्रलेखन के प्रत्येक पृष्ठ पर अपने स्वयं के उदाहरण और नोट्स जोड़ने के लिए प्रोत्साहित करता है। यह विषय सर्वोत्तम अभ्यास के लिए टिप्स, ट्रिक्स और दिशानिर्देशों के साथ PHP मैनुअल में योगदान की व्याख्या करता है।

टिप्पणियों

इस विषय में योगदान मुख्य रूप से PHP मैनुअल में योगदान करने के आसपास की प्रक्रिया को रेखांकित करना चाहिए, उदाहरण के लिए, पृष्ठों को कैसे जोड़ना है, उन्हें समीक्षा के लिए कैसे प्रस्तुत करना है, सामग्री का योगदान करने के लिए क्षेत्रों का पता लगाना, इत्यादि।

आधिकारिक दस्तावेज में सुधार करें

PHP के पास पहले से ही http://php.net/manual/ पर शानदार आधिकारिक दस्तावेज हैं। PHP मेनुअल दस्तावेज़ में सभी भाषा सुविधाएँ, मुख्य पुस्तकालय और सबसे अधिक उपलब्ध एक्सटेंशन हैं। से सीखने के लिए बहुत सारे उदाहरण हैं। PHP मैनुअल कई भाषाओं और प्रारूपों में उपलब्ध है।

सभी के लिए, प्रलेखन किसी को भी संपादित करने के लिए स्वतंत्र है ।

PHP डॉक्यूमेंटेशन टीम https://edit.php.net पर PHP मैनुअल के लिए एक ऑनलाइन संपादक प्रदान करती है। यह आपके स्टैक ओवरफ्लो खाते में लॉग इन करने सहित कई सिंगल-साइन-ऑन सेवाओं का समर्थन करता है। आप https://wiki.php.net/doc/editor पर संपादक का परिचय पा सकते हैं।

PHP डॉक्युमेंट टीम से लोगों को अप्रूव करने की जरूरत है PHP डॉक्यूमेंट टीम के पास Doc कर्म है । डॉक्टर कर्म कुछ हद तक प्रतिष्ठा की तरह है, लेकिन इसे प्राप्त करना कठिन है। यह सहकर्मी समीक्षा प्रक्रिया सुनिश्चित करती है कि PHP मैन्युअल में केवल तथ्यात्मक रूप से सही जानकारी मिलती है।

PHP पुस्तिका डॉकबुक में लिखी गई है, जो पुस्तकों को लिखने के लिए मार्कअप भाषा सीखना आसान है। यह पहली नज़र में थोड़ा जटिल लग सकता है, लेकिन आपको शुरू करने के लिए टेम्पलेट हैं। आप निश्चित रूप से योगदान करने के लिए एक डॉकबुक विशेषज्ञ होने की आवश्यकता नहीं है।

मैनुअल में योगदान करने के लिए टिप्स

निम्नलिखित उन लोगों के लिए सुझावों की एक सूची है जो PHP मैनुअल में योगदान करना चाहते हैं:

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

Modified text is an extract of the original Stack Overflow Documentation

के तहत लाइसेंस प्राप्त है CC BY-SA 3.0

से संबद्ध नहीं है Stack Overflow