Bokeh प्रोजेक्ट

इस पेज पर, तकनीकी लेखन वाले उस प्रोजेक्ट की जानकारी दी गई है जिसे Google Season of Docs के लिए स्वीकार किया गया है.

प्रोजेक्ट की खास जानकारी

ओपन सोर्स संगठन:
बोकेह
टेक्निकल राइटर:
vis_verborum
प्रोजेक्ट का नाम:
बोकेह के दस्तावेज़ बनाना, पढ़ना, शेयर करना
प्रोजेक्ट की अवधि:
स्टैंडर्ड अवधि (तीन महीने)

प्रोजेक्ट का विवरण

बनाना, पढ़ना, शेयर करना: Bokeh के दस्तावेज़ को ऑप्टिमाइज़ करना

1. खास जानकारी

Python की मदद से, ब्राउज़र पर आधारित इंटरैक्टिव विज़ुअलाइज़ेशन बनाने के लिए, Bokeh एक बेहद असरदार टूल है. इसका उपयोगकर्ता आधार बड़ा है. हर महीने, conda के 5,02,000 और PyPi के 8,55,000 इंस्टॉल डाउनलोड किए जाते हैं. साथ ही, इसमें योगदान देने वाले लोगों की संख्या भी ज़्यादा है. GitHub पर 455 लोग योगदान देते हैं. इसमें कोई हैरानी की बात नहीं कि Bokeh का ज़्यादातर दस्तावेज़, अपने-आप तैयार हुआ है. इसलिए, कुछ जगहों पर यह जानकारी अलग-अलग होती है, ऐक्सेस करना मुश्किल होता है, और जटिल होती है.

Google के 'Docs का सीज़न' सेक्शन में, बोकेह के दस्तावेज़ों के स्ट्रक्चर और कॉन्टेंट की खास तौर पर समीक्षा करने और उनमें बदलाव करने का खास मौका मिलता है. साथ ही, इससे यह पक्का किया जा सकता है कि दस्तावेज़ और उससे जुड़े टूल और वर्कफ़्लो, आने वाले समय में सही साबित हों.

मैंने Python और Sphinx की मदद से, ओपन-सोर्स प्रोजेक्ट कोड किया है और उनके दस्तावेज़ बनाए हैं. हाल ही में, मैंने PyZillow और PyPresseportal प्रोजेक्ट कोड किया है. हालांकि, मुझे Google के 'सीज़न ऑफ़ डॉक्स' में हिस्सा लेने वाला एक खास व्यक्ति इसलिए माना जाता है, क्योंकि मेरी पत्रकारिता की पृष्ठभूमि है: मैंने 13 साल से ज़्यादा समय तक न्यूज़रूम में काम किया है. इसमें कई साल मैनेजिंग एडिटर और डिजिटल बदलाव के पैरोकार के तौर पर काम किया है. पत्रकारिता से जुड़ी अपनी ज़िम्मेदारियों के अलावा, मेरे पास नए डिजिटल टूल और स्टाइल गाइड को डिज़ाइन करने और दस्तावेज़ बनाने की ज़िम्मेदारियां भी थीं. साथ ही, मुझे न्यूज़रूम के स्टाफ़ को ट्रेनिंग भी देनी थी.

हाल ही में, यूरोप से अमेरिका जाने के बाद, मैंने यह तय किया कि मैं कम्यूनिकेशन और कोडिंग के लिए, अपने उत्साह को एक साथ जगाऊंगी. मुझे लगता है कि तकनीकी लेखन, लेखन और टेक्नोलॉजी में मेरी स्किल और अनुभवों का सबसे अच्छा कॉम्बिनेशन है. इस प्रस्ताव में, मैं बताऊंगा कि मैं Bokeh के दस्तावेज़ को ऑप्टिमाइज़ करने के लिए, Google के सीज़न ऑफ़ दस्तावेज़ का इस्तेमाल कैसे करूंगा: दस्तावेज़ को बनाने और उसमें योगदान देने की प्रोसेस को आसान बनाकर, दस्तावेज़ को पढ़ने की प्रोसेस को आसान बनाकर, और दस्तावेज़ में मौजूद जानकारी को दूसरों के साथ शेयर करने की प्रोसेस को आसान बनाकर.

2. मौजूदा स्थिति

Bokeh के आधिकारिक दस्तावेज़ में ये मुख्य यूनिट शामिल हैं:

  • जानकारी देने वाला दस्तावेज़: इंस्टॉल करने की गाइड, इस्तेमाल के लिए गाइड, डेवलपर के लिए गाइड, प्रॉडक्ट की जानकारी
  • गैलरी और डेमो (सोर्स कोड के साथ इंटरैक्टिव उदाहरण)
  • रेफ़रंस गाइड (docstring पर आधारित दस्तावेज़)
  • ट्यूटोरियल (mybinder.org पर होस्ट की गई Jupyter notebook का बड़ा कलेक्शन)
  • आईडीई के लिए दस्तावेज़ और मॉडल से जुड़ी सहायता
  • प्रोजेक्ट रिपॉज़िटरी में मौजूद उदाहरण और README

इसके अलावा, Bokeh के सहायता फ़ोरम और Stack Overflow पर काफ़ी जानकारी उपलब्ध है. यहां Bokeh के डेवलपर, उपयोगकर्ताओं के सवालों के जवाब देते हैं. साथ ही, Bokeh के Medium ब्लॉग पर भी काफ़ी जानकारी उपलब्ध है.

ज़्यादातर दस्तावेज़ के वेब पेज स्फ़िंक्स की मदद से, कई मानक और कस्टम स्फ़िंक्स एक्सटेंशन का इस्तेमाल करके बनाए जाते हैं. उदाहरण के लिए, रेफ़रंस गाइड, 'autodoc' और कस्टम 'bokeh_autodoc' जैसे एक्सटेंशन का इस्तेमाल करके, दस्तावेज़ों से जनरेट की जाती है. ऑर्गैनिक तरीके से तैयार किए गए दस्तावेज़ों की तरह, इसमें भी ग़ैर-ज़रूरी जानकारी और अंतर-संबंध मौजूद होते हैं.

मौजूदा दस्तावेज़ों का विश्लेषण करते समय, मुझे सबसे पहले यह पता चला कि दस्तावेज़ लिखने के लिए, स्टाइल से जुड़े साफ़ दिशा-निर्देश मौजूद नहीं हैं. Bokeh डेवलपर गाइड में कुछ बुनियादी निर्देश दिए गए हैं. हालांकि, इस दस्तावेज़ में स्टाइल के बारे में ज़्यादा जानकारी नहीं दी गई है. खास तौर पर, दस्तावेज़ के बारे में, जो docstrings से परे है. इस वजह से, दस्तावेज़ों में मौजूद जानकारी को ऐक्सेस करना मुश्किल हो जाता है. खास तौर पर, नए लोगों के लिए.

उदाहरण के लिए:

Bokeh का दस्तावेज़ का लैंडिंग पेज छोटा है. इसमें सभी उपलब्ध संसाधनों की जानकारी शामिल नहीं है. जैसे, दस्तावेज़ों और मॉडल के सहायता फ़ंक्शन की बड़ी लाइब्रेरी, सहायता फ़ोरम, डेमो या Medium ब्लॉग. इससे नए उपयोगकर्ताओं के लिए, बोकेह मोड का इस्तेमाल करना भी मुश्किल हो जाता है.

3. लक्ष्य

दस्तावेज़ को तैयार करने में लगने वाले 11 हफ़्तों का ज़्यादा से ज़्यादा फ़ायदा पाने के लिए, मैं इन तीन अहम बातों पर फ़ोकस करूंगा:

3.1. दस्तावेज़ बनाने की सुविधा को बेहतर बनाना

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

हम दो तरीकों से यह पक्का करेंगे:

  • मैं मौजूदा डेवलपर गाइड में शामिल करने के लिए, स्टाइल से जुड़े दिशा-निर्देशों का एक सेट बनाऊंगा. ये दिशा-निर्देश, काम के और आसान होंगे. ये दिशा-निर्देश, स्टाइल, व्याकरण, और स्ट्रक्चर के बारे में होंगे. इसके अलावा, मैं Slack जैसे इंटरनल कम्यूनिकेशन चैनलों का इस्तेमाल करके यह पक्का करूंगा कि Bokeh के योगदान देने वाले लोगों को स्टाइल से जुड़े दिशा-निर्देशों के बारे में पता हो. मैं टीम के लिए निजी ट्रेनिंग और सवाल-जवाब वाले सेशन भी उपलब्ध कराऊंगा.
  • मैं मुख्य टीम के साथ मिलकर, दस्तावेज़ की क्वालिटी कंट्रोल करने के लिए टूल का सबसे अच्छा सेट ढूंढूंगा. इसे PR (पुल रिक्वेस्ट) और सीआई (कंटिन्यूअस इंटिग्रेशन) के लिए, Bokeh के मौजूदा वर्कफ़्लो में जोड़ा जाएगा. टीम की ज़रूरतों के हिसाब से, इसका मतलब Bokeh के टेस्टिंग सुइट, प्री-कमिट सेटअप या GitHub ऐक्शन में, स्पेलिंग की जांच करने वाले टूल जोड़ना हो सकता है. जैसे, pydocstyle, proselint या sphinxcontrib-spelling. मैंने अपने एक ओपन-सोर्स प्रोजेक्ट की GitHub कार्रवाइयों में, काम करने वाले कॉन्सेप्ट का सबूत जोड़ा है.

3.2. दस्तावेज़ों को बेहतर तरीके से पढ़ना

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

किसी टेक्स्ट के इस्तेमाल के लिए, उसका स्टाइल और स्ट्रक्चर अहम होता है: दस्तावेज़ को साफ़ और एक जैसा स्टाइल में लिखने से, पाठक बिना किसी रुकावट के और ज़रूरत से ज़्यादा शब्दों के बिना जानकारी को तुरंत समझ सकते हैं. दस्तावेज़ों का आसान और पारदर्शी स्ट्रक्चर, काम की जानकारी को तुरंत ढूंढने में मदद करता है.

हम इन दोनों पहलुओं पर ध्यान देंगे. साथ ही, नए उपयोगकर्ताओं के लिए, ऐप्लिकेशन को इस्तेमाल करने में आसानी पर भी फ़ोकस करेंगे. इसमें, उपयोगकर्ता गाइड के आधार पर, जानकारी वाले दस्तावेज़ की पूरी समीक्षा की जाएगी. मैं अलग-अलग टारगेट ऑडियंस के बारे में साफ़ तौर पर जानकारी देने के लिए, दस्तावेज़ के लैंडिंग पेज में भी बदलाव करूंगा/करूंगी. साथ ही, यह पक्का करूंगा/करूंगी कि सभी उपयोगकर्ताओं को सही संसाधन तेज़ी से मिलें.

जिस तरह ऊपर बताए गए दस्तावेज़ों को बेहतर बनाने में मदद मिलती है, ठीक उसी तरह मेरा फ़ोकस आने वाले समय में होने वाले सुधारों की बुनियाद तैयार करने और बोकेह के डॉक्यूमेंटेशन के लिए लगातार बेहतर स्टैंडर्ड बनाए रखने पर है.

3.3. दस्तावेज़ शेयर करने में सुधार करें

तीसरे पक्ष के प्लैटफ़ॉर्म पर, बोकेह को लेकर चर्चाएं लगातार बढ़ रही हैं. इनमें से कई प्लैटफ़ॉर्म, लिंक की रिच प्रीव्यू शामिल करने के लिए, Facebook के OpenGraph जैसे मेटाडेटा का इस्तेमाल करते हैं. OpenGraph का इस्तेमाल Facebook, Twitter, LinkedIn, Slack, और iMessage जैसी सेवाएं करती हैं. Bokeh का Discourse फ़ोरम भी लिंक की झलक दिखाने के लिए, OpenGraph का इस्तेमाल करता है.

इस टेक्नोलॉजी का इस्तेमाल करने के लिए, मैं Bokeh के Sphinx से जनरेट किए गए वेब पेजों में मेटाडेटा जोड़ूंगा, जैसा कि समस्या #9792 में बताया गया है. सबसे असरदार तरीका, Sphinx एक्सटेंशन का इस्तेमाल करना है. कुछ दिन पहले, OpenGraph डेटा के लिए Sphinx एक्सटेंशन का पहला वर्शन GitHub पर पब्लिश किया गया था. मैं दस्तावेज़ों के डेवलपमेंट के कुछ चरणों का इस्तेमाल करके, इस एक्सटेंशन को बेहतर बनाऊंगा, ताकि इसे Bokeh के दस्तावेज़ों के साथ इस्तेमाल किया जा सके.

मैंने इस कॉन्सेप्ट को साबित करने के लिए एक प्रोजेक्ट भी बनाया है. इसका इस्तेमाल, अपने ओपन सोर्स प्रोजेक्ट PyPresseportal में किया जा रहा है. यह एक्सटेंशन, काम की जानकारी अपने-आप इकट्ठा करता है. जैसे, टाइटल, ब्यौरा, इमेज, और यूआरएल. इसके बाद, यह जानकारी Sphinx से जनरेट किए गए एचटीएमएल कोड में, OpenGraph टैग के तौर पर डाल दी जाती है.

इस एक्सटेंशन को डेवलप करने के अगले चरण में, OpenGraph मेटाडेटा को मैन्युअल तरीके से तय करने के लिए कस्टम डायरेक्टिव जोड़े जाएंगे. ये डायरेक्टिव, docutil के मौजूदा 'meta' डायरेक्टिव जैसे ही होंगे. अपने-आप जनरेट हुए मेटाडेटा का इस्तेमाल, सिर्फ़ तब किया जाएगा, जब मैन्युअल तरीके से डाला गया डेटा उपलब्ध न हो.

स्ट्रक्चर्ड डेटा के साथ काम करना काफ़ी मुश्किल है. इसलिए, मैं Bokeh के दस्तावेज़ों के लिए, मुख्य रूप से अच्छी क्वालिटी का OpenGraph मेटाडेटा शामिल करने पर फ़ोकस करूंगा. OpenGraph के साथ काम करने के लिए किया जाने वाला हर काम, स्ट्रक्चर्ड डेटा के साथ काम करने के लिए भी काम करेगा.

Sphinx और ReadTheDocs कम्यूनिटी के सदस्यों ने OpenGraph और स्ट्रक्चर्ड डेटा के लिए एक्सटेंशन बनाने में दिलचस्पी दिखाई है. उदाहरण के लिए, #1758 और #5208 में. हम इनके साथ मिलकर काम करेंगे.

4. डिलीवर किया जाने वाला कॉन्टेंट

खास जानकारी देने के लिए, Docs के सीज़न में ये डिलीवर किए जा सकते हैं:

  • Bokeh के लिए दस्तावेज़ तैयार करने के स्टाइल से जुड़े दिशा-निर्देश
  • दस्तावेज़ की क्वालिटी को अपने-आप कंट्रोल करने की सुविधा शामिल करने के लिए, PR और CI वर्कफ़्लो में बदलाव किया गया
  • उपयोगकर्ता के लिए गाइड में बदलाव किया गया और उसका स्ट्रक्चर बदला गया
  • दस्तावेज़ का अपडेट किया गया लैंडिंग पेज
  • दस्तावेज़ के वेब पेजों और काम करने वाले स्फ़िंक्स एक्सटेंशन में OpenGraph मेटाडेटा शामिल है

इसके अलावा, मैं अपनी निजी वेबसाइट/Medium या Bokeh के Medium ब्लॉग पर, Google के सीज़न ऑफ़ द डॉक्स के दौरान अपनी यात्रा को दस्तावेज़ के तौर पर रिकॉर्ड करने के लिए, “डॉकलॉग” बनाए रखूंगा. यह Google के लिए प्रोजेक्ट रिपोर्ट के आधार के तौर पर भी काम करेगा. जब भी संभव होगा, मैं GitHub पर समस्याओं और पुल के अनुरोध के तौर पर साफ़ तौर पर काम करूंगा.

5. टाइमलाइन

कम्यूनिटी बॉन्डिंग से पहले: मैं पहले से ही Bokeh के GitHub रिपॉज़िटरी पर कई चर्चाओं में हिस्सा ले रहा/रही हूं. साथ ही, Google के सीज़न ऑफ़ डॉक्स के लिए, Bokeh के मेंटर ब्रैयन वैन डे वेन और पवित्रा एश्वरमूर्ति से संपर्क में हूं/हूँ. मैं Bokeh के बारे में बातचीत में शामिल रहूंगा. साथ ही, विज़ुअलाइज़ेशन बनाकर और पब्लिश करके, Bokeh के बारे में ज़्यादा जानकारी हासिल करूंगा.

कम्यूनिटी बॉन्डिंग फ़ेज़ (17/08 - 13/09):

  • मुख्य टीम के बारे में जानें और मेंटर के साथ प्रोजेक्ट प्लान को बेहतर बनाएं
  • नियमित रिपोर्टिंग और मेंटॉर के साथ फ़ीडबैक पाने के लिए, शेड्यूल और कम्यूनिकेशन चैनल सेट अप करें
  • Bokeh के Slack पर सक्रिय रहें, ताकि Bokeh के उन सभी योगदानकर्ताओं को Google के 'सीज़न ऑफ़ दॉक्स' और दस्तावेज़ डेवलपमेंट के फ़ेज़ के लक्ष्यों के बारे में बताया जा सके जो इसमें दिलचस्पी रखते हैं
  • बोकेह में योगदान देने वालों से सुझाव लें, ताकि दस्तावेज़ तैयार करने के चरण को और बेहतर बनाया जा सके

दस्तावेज़ डेवलप करने का चरण

पहला हफ़्ता, 14/09 से 20/09:

  • जानकारी वाले दस्तावेज़ों की ऑडिटिंग करना और उनमें बदलाव करना
  • स्टाइल से जुड़े दिशा-निर्देशों का ड्राफ़्ट तैयार करें

दूसरा हफ़्ता, 21/09 - 27/09:

  • स्टाइल से जुड़े दिशा-निर्देशों पर काम जारी रखना
  • जानकारी वाले दस्तावेज़ में बदलाव करना जारी रखना
  • दस्तावेज़ के लैंडिंग पेज में बदलाव करना शुरू करें

तीसरा हफ़्ता, 28/09 - 04/10:

  • स्टाइल के दिशा-निर्देशों को फ़ाइनल करना
  • दस्तावेज़ के लैंडिंग पेज को फ़ाइनल करना

चौथा हफ़्ता, 10/05 से 10/11:

  • ब्यौरे के दस्तावेज़ में बदलाव करने की प्रोसेस पूरी करें
  • PR/CI वर्कफ़्लो में दस्तावेज़ की क्वालिटी कंट्रोल के लिए टूल इंटिग्रेट करने के बारे में, Bokeh की मुख्य टीम से बातचीत करना

पांचवां हफ़्ता, 12/10 से 18/10:

  • Bokeh के योगदान देने वालों के साथ, Slack पर सवाल-जवाब का सेशन सेट अप करना. इसमें स्टाइल के दिशा-निर्देशों, नैरेटिव दस्तावेज़ में सुधारों, और PR/CI वर्कफ़्लो के बारे में चर्चा की जाएगी
  • OpenGraph मेटाडेटा के लिए मेरे मौजूदा कॉन्सेप्ट के सबूत को, डिप्लॉय किए जा सकने वाले स्फ़िंक्स एक्सटेंशन में बदल दें
  • Bokeh के योगदान देने वालों के साथ सवाल-जवाब के सेशन में मिले सुझावों के आधार पर, स्टाइल के दिशा-निर्देशों में बदलाव करना

छठा हफ़्ता, 19/10 - 25/10:

  • पीआर और सीआई वर्कफ़्लो में दस्तावेज़ की क्वालिटी कंट्रोल करने के लिए, टूल की जांच शुरू करना
  • मेटाडेटा के लिए स्फ़िंक्स एक्सटेंशन का डेवलपमेंट जारी रखें

सातवां हफ़्ता, 26/10 - 01/11:

  • Sphinx एक्सटेंशन की जांच करना
  • Slack पर बोकेह में योगदान देने वालों के साथ सवाल और जवाब का दूसरा सेशन
  • दूसरे सवाल-जवाब सेशन के सुझावों के आधार पर, डिलीवर किए जाने वाले आइटम में बदलाव करना

आठवां हफ़्ता, 11/02 - 11/08:

  • Sphinx एक्सटेंशन को डिप्लॉय करना और बेहतर जानकारी वाला दस्तावेज़ और दस्तावेज़ का लैंडिंग पेज पब्लिश करना

नौवां हफ़्ता, 09/11 से 15/11:

  • पीआर और सीआई के वर्कफ़्लो में दस्तावेज़ की क्वालिटी कंट्रोल करने वाले टूल डिप्लॉय करें
  • स्टाइल से जुड़े दिशा-निर्देश और पीआर और सीआई वर्कफ़्लो जोड़ने के लिए, डेवलपर गाइड को अपडेट और पब्लिश करें

हफ़्ता 10, 11/16 से 22/11:

  • बाकी टास्क पूरे करना

11वां हफ़्ता, 23/11 से 29/11:

  • प्रोजेक्ट रिपोर्ट लिखना शुरू करना
  • प्रोजेक्ट का आकलन लिखना

प्रोजेक्ट पूरा होने का चरण

12वां हफ़्ता, 30/11 - 05/12:

  • प्रोजेक्ट रिपोर्ट को फ़ाइनल करना और सबमिट करना

हफ़्ता 13, 12/03 से 12/10:

  • प्रोजेक्ट इवैलुएशन को पूरा करें और सबमिट करें

Google के 'सीज़न ऑफ़ द डॉक्स' खत्म होने के बाद:

  • मुझे उम्मीद है कि मैं Bokeh के डेवलपमेंट में शामिल रहूंगा और Bokeh के दस्तावेज़ पर काम करता रहूंगा.
  • मेरा प्लान है कि मैं OpenGraph/स्ट्रक्चर्ड डेटा मेटाडेटा के लिए, Sphinx एक्सटेंशन को डेवलप करना जारी रखूं.
  • मुझे उम्मीद है कि मैं डेटा पत्रकारिता के क्षेत्र में बोकेह को बढ़ावा देने के लिए, पत्रकारिता के अपने बैकग्राउंड और अपने मौजूदा नेटवर्क का इस्तेमाल कर पाऊंगा. उदाहरण के लिए, पत्रकारिता से जुड़ी ऑडियंस को ध्यान में रखकर Bokeh के बारे में लिखना या पत्रकारिता से जुड़ी सेटिंग में Bokeh का इस्तेमाल करने के बारे में कॉन्फ़्रेंस में बातचीत करना.

6. मेरे बारे में जानकारी

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

मुझे हमेशा से कम्यूनिकेशन और टेक्नोलॉजी के बीच के इंटरसेक्शन में दिलचस्पी रही है. Python में कोडिंग सीखने के बाद, मेरे लिए एक नई दुनिया खुली: उदाहरण के लिए, डेटा जर्नलिज़्म के लिए डेटा का विश्लेषण और विज़ुअलाइज़ेशन किया जा सकता है. कोडिंग सीखने से, मुझे सॉफ़्टवेयर इंजीनियर के साथ मिलकर काम करने में भी मदद मिली है. इसकी मदद से, मैं न्यूज़रूम के वर्कफ़्लो के लिए डिजिटल टूल डेवलप कर पा रहा हूं.

माफ़ करें, मेरी पिछली नौकरी में लिखे गए मैन्युअल और दस्तावेज़ सार्वजनिक नहीं हैं. इसलिए, अब मैं ओपन-सोर्स प्रोजेक्ट में ज़्यादा से ज़्यादा शामिल होने पर फ़ोकस कर रहा हूं. उदाहरणों के लिए नीचे देखें. मैंने तकनीकी लेखन में, स्टाइल गाइड पर आधारित काम किया है. जैसे, Google के डेवलपर दस्तावेज़ की स्टाइल गाइड और Microsoft की स्टाइल गाइड. मैं नियमित तौर पर GitHub, Slack, और Linux का इस्तेमाल करता/करती हूं. मैंने Sphinx, Mypy, और Sphinx autodoc जैसे टूल का इस्तेमाल करके, नैरेटिव दस्तावेज़ों के साथ-साथ डोकस्ट्रिंग और टाइप हिंट लिखे हैं.

फ़िलहाल, मैं फ़्रीलांसर के तौर पर काम कर रहा/रही हूं. मेरे शेड्यूल से, दस्तावेज़ बनाने के दौरान हर हफ़्ते करीब 25 घंटे तक Bokeh के दस्तावेज़ पर काम करने में मदद मिलती है. मैं पैसिफ़िक टाइम ज़ोन में काम करती हूं. हालांकि, मुझे टीम के शेड्यूल और ज़रूरतों के मुताबिक काम करने में खुशी होगी.

7. ओपन सोर्स के दस्तावेज़ों के हाल ही के उदाहरण

  • PyZillow: PyZillow, रीयल एस्टेट वेबसाइट Zillow.com के एपीआई के लिए Python रैपर है. मैंने कुछ कोड देने के साथ-साथ, कोड को मैनेज करने वाले लोगों में से एक के तौर पर काम किया. साथ ही, पूरा दस्तावेज़ भी लिखा. मैंने नैरेटिव दस्तावेज़ के साथ-साथ मॉड्यूल के रेफ़रंस के लिए भी Sphinx का इस्तेमाल किया. मैंने कोड में जोड़े गए दस्तावेज़ों के आधार पर, Sphinx एक्सटेंशन autodoc की मदद से मॉड्यूल रेफ़रंस बनाया.

  • PyPresseportal: PyPresseportal, presseportal.de वेबसाइट के एपीआई के लिए Python रैपर है. Presseportal.de वेबसाइट, जर्मनी में प्रेस रिलीज़ और इन्वेस्टर रिलेशन के एलान के सबसे बड़े डिस्ट्रिब्यूटर में से एक है. उदाहरण के लिए, पुलिस और फ़ायर डिपार्टमेंट के करीब सभी लोग, अपनी प्रेस रिलीज़ शेयर करने के लिए इस सेवा का इस्तेमाल करते हैं. पत्रकार के तौर पर कई सालों तक एपीआई का इस्तेमाल करने के बाद, मैंने वेबसाइट के बड़े डेटा संसाधनों को Python ऑब्जेक्ट के तौर पर ऐक्सेस करने के लिए, Python इंटरफ़ेस बनाने का फ़ैसला किया. मैंने कोड और Sphinx पर आधारित पूरा दस्तावेज़ लिखा है.