বোকেহ প্রকল্প

এই পৃষ্ঠায় Google সিজন অফ ডক্সের জন্য গৃহীত প্রযুক্তিগত লেখার প্রকল্পের বিশদ বিবরণ রয়েছে৷

প্রকল্পের সারসংক্ষেপ

ওপেন সোর্স সংস্থা:

বোকেহ

কৌশলী লেখক:

vis_verborum

প্রকল্পের নাম:

তৈরি করা, পড়া, ভাগ করা: Bokeh এর ডকুমেন্টেশন অপ্টিমাইজ করা

প্রকল্পের দৈর্ঘ্য:

স্ট্যান্ডার্ড দৈর্ঘ্য (3 মাস)

প্রকল্প বর্ণনা

তৈরি করা, পড়া, ভাগ করা: Bokeh এর ডকুমেন্টেশন অপ্টিমাইজ করা

1. বিমূর্ত

Bokeh পাইথনের সাথে ইন্টারেক্টিভ, ব্রাউজার-ভিত্তিক ভিজ্যুয়ালাইজেশন তৈরি করার জন্য একটি অত্যন্ত শক্তিশালী টুল। এটির একটি বিশাল ব্যবহারকারী বেস (502k মাসিক কনডা ডাউনলোড, 855k PyPi ডাউনলোড) এবং বিপুল সংখ্যক অবদানকারী (GitHub-এ 455 অবদানকারী) রয়েছে। এটা কোন আশ্চর্যের বিষয় নয় যে বোকেহ এর ব্যাপক ডকুমেন্টেশন জৈবভাবে বেড়েছে। এবং এইভাবে, জায়গায়, অসংলগ্ন, অ্যাক্সেস করা কঠিন, এবং জটিল।

Google-এর ডক্সের সিজন বোকেহ-এর ডকুমেন্টেশনের কাঠামো এবং বিষয়বস্তুগুলির একটি ফোকাসড পর্যালোচনা এবং পুনর্বিবেচনার জন্য একটি অনন্য সুযোগ প্রদান করে - এবং নিশ্চিত করার জন্য যে ডকুমেন্টেশন এবং সংশ্লিষ্ট সরঞ্জাম এবং কর্মপ্রবাহগুলি ভবিষ্যতের প্রমাণ।

আমি পাইথন এবং স্ফিনক্সের সাথে ওপেন সোর্স প্রকল্পগুলি কোড করেছি এবং নথিভুক্ত করেছি (সর্বাধিক: PyZillow এবং PyPresseportal )। কিন্তু যা আমাকে Google-এর সিজন অফ ডক্সের অনন্য অংশগ্রহণকারী করে তোলে তা হল সাংবাদিকতায় আমার পটভূমি: আমি 13 বছরেরও বেশি সময় ধরে নিউজরুমে কাজ করেছি, বহু বছর ধরে একজন ব্যবস্থাপনা সম্পাদক এবং ডিজিটাল পরিবর্তনের প্রবক্তা হিসেবে। আমার সাংবাদিকতার দায়িত্বের পাশাপাশি, নতুন ডিজিটাল টুলস এবং স্টাইল গাইড ডিজাইন এবং ডকুমেন্ট করার পাশাপাশি নিউজরুমের কর্মীদের প্রশিক্ষণ দেওয়ার দায়িত্বও আমার ছিল।

ইউরোপ থেকে মার্কিন যুক্তরাষ্ট্রে সাম্প্রতিক স্থানান্তরের পরে, আমি যোগাযোগ এবং কোডিংয়ের জন্য আমার উত্সাহকে একত্রিত করার নতুন উপায়গুলি সন্ধান করার সিদ্ধান্ত নিয়েছি। আমি প্রযুক্তিগত লেখাকে আমার দক্ষতা এবং লেখার এবং প্রযুক্তিগত অভিজ্ঞতার সর্বোত্তম সমন্বয় হিসাবে খুঁজে পেয়েছি। এই প্রস্তাবে, আমি ব্যাখ্যা করব কীভাবে আমি Bokeh-এর ডকুমেন্টেশন অপ্টিমাইজ করতে Google-এর সিজন অফ ডক্স ব্যবহার করব: ডকুমেন্টেশন তৈরি করা এবং তাতে অবদান রাখা আরও সুবিধাজনক করে, ডকুমেন্টেশন পড়া আরও সহজ করে এবং অন্যদের সাথে ডকুমেন্টেশনে তথ্য শেয়ার করা সহজ করে।

2. বর্তমান পরিস্থিতি

Bokeh এর অফিসিয়াল ডকুমেন্টেশন এই প্রধান ইউনিটগুলি নিয়ে গঠিত:

• বর্ণনামূলক ডকুমেন্টেশন: ইনস্টলেশন গাইড, ইউজার গাইড, ডেভেলপার গাইড, রিলিজ নোট
• গ্যালারি এবং ডেমো (তাদের উত্স কোডের সাথে ইন্টারেক্টিভ উদাহরণ)
• রেফারেন্স গাইড (ডকস্ট্রিং এর উপর ভিত্তি করে ডকুমেন্টেশন)
• টিউটোরিয়াল (জুপিটার নোটবুকের বিস্তৃত সংগ্রহ, mybinder.org-এ হোস্ট করা)
• আইডিই-এর জন্য ডকস্ট্রিং এবং মডেল সহায়তা
• প্রজেক্ট রিপোজিটরিতে উদাহরণ এবং READMEs

উপরন্তু, বোকেহ সমর্থন ফোরামে এবং স্ট্যাক ওভারফ্লোতে প্রচুর তথ্য পাওয়া যায়, যেখানে বোকেহের বিকাশকারী সক্রিয়ভাবে ব্যবহারকারীর প্রশ্নের উত্তর দেয়, সেইসাথে বোকেহের মিডিয়াম ব্লগে।

বেশিরভাগ ডকুমেন্টেশন ওয়েব পেজ স্ফিংস দিয়ে তৈরি করা হয়, বেশ কিছু স্ট্যান্ডার্ড এবং কাস্টম স্ফিংস এক্সটেনশন ব্যবহার করে। রেফারেন্স গাইড, উদাহরণস্বরূপ, 'অটোডক' এবং কাস্টম 'বোকেহ_অটোডক'-এর মতো এক্সটেনশন ব্যবহার করে ডকস্ট্রিং থেকে তৈরি করা হয়। জৈবভাবে বেড়ে ওঠা ডকুমেন্টেশনের প্রকৃতি যেমন, এতে অপ্রয়োজনীয়তা এবং অসঙ্গতি রয়েছে।

বিদ্যমান ডকুমেন্টেশন বিশ্লেষণ করার সময় আমি প্রথম যে জিনিসটি লক্ষ্য করেছি তা হল ডকুমেন্টেশন লেখার জন্য স্পষ্ট শৈলী নির্দেশিকাগুলির অভাব। Bokeh ডেভেলপার গাইডে কিছু মৌলিক নির্দেশ রয়েছে। যাইহোক, এই নথিতে শৈলী সম্পর্কে খুব বেশি নির্দেশিকা নেই, বিশেষ করে ডকুমেন্টেশন সংক্রান্ত যা ডকস্ট্রিং-এর বাইরে যায়। ফলস্বরূপ, শৈলীগত এবং কাঠামোগত সমস্যাগুলি নথিতে তথ্য অ্যাক্সেস করা আরও কঠিন করে তোলে, বিশেষ করে নতুনদের জন্য।

উদাহরণ স্বরূপ:

• স্পষ্ট এবং শক্তিশালী ক্রিয়াপদের পরিবর্তে বিশেষ্য, gerunds এবং অস্বাভাবিক শব্দগুলি ব্যবহার করা কিছু পাঠ্যকে অপ্রয়োজনীয়ভাবে জটিল করে তোলে: "প্রধান পর্যবেক্ষণ হল যে সাধারণ ব্যবহার চিত্র() ফাংশনের সাথে প্লট অবজেক্ট তৈরি করা জড়িত"। পড়া সহজ করার জন্য এটি পুনরায় শব্দ করা উচিত। উদাহরণস্বরূপ: "চিত্র() ফাংশনটি প্লট অবজেক্ট তৈরি করতে সবচেয়ে বেশি ব্যবহৃত ফাংশন।"
• কিছু বাক্য অনেক দীর্ঘ, সেগুলি বোঝা কঠিন করে তোলে: “এরপরে আমরা vbar-কে বলতে পারি ফলের নামের ফ্যাক্টরগুলির তালিকা সহ x স্থানাঙ্ক হিসাবে, বারের উচ্চতাকে শীর্ষ স্থানাঙ্ক হিসাবে, এবং ঐচ্ছিকভাবে যে কোনও প্রস্থ বা অন্যান্য বৈশিষ্ট্য যা আমরা চাই। সেট" । দীর্ঘ বাক্যগুলিকে ছোট বাক্য বা বুলেটেড তালিকায় বিভক্ত করা উচিত। ডিসলেক্সিয়ায় আক্রান্ত ব্যবহারকারী বা যারা ইংরেজিকে তাদের প্রথম ভাষা হিসেবে ব্যবহার করেন না তাদের জন্য সরলীকৃত বাক্য বিশেষভাবে সহায়ক হবে (ইস্যু #10160 দেখুন)।
• "আপনি" এবং "আমরা" এর অসঙ্গতিপূর্ণ ব্যবহার, যা বিভ্রান্তিকর এবং বিভ্রান্তিকর: "আপনার ব্যবহারের ক্ষেত্রে নির্ভর করে দুটি মৌলিক পদ্ধতি ব্যবহার করা যেতে পারে" এবং "আমরা পৃথক কল ব্যবহার করে সারা বছরের সিরিজ প্লট করতে পারি" (দুটি উদাহরণ একই পৃষ্ঠা থেকে)। কিছু পৃষ্ঠা এমনকি বিভিন্ন উপায়ে পাঠকদের সম্বোধন করে, যেমন: "ব্যবহারকারীদের অতিরিক্ত নির্ভরতা ইনস্টল করতে হতে পারে" বা "একজন আরও জটিল লেআউট তৈরি করতে পারে" ।
• টাইপো, অনুপস্থিত এবং অপ্রয়োজনীয় শব্দ এবং ব্যাকরণগত ত্রুটিগুলি পড়ার প্রবাহকে ভেঙে দেয় এবং তথ্যের বিশ্বাসযোগ্যতাকে ক্ষতিগ্রস্ত করে: "বোকেহ মৌলিক বার চার্ট তৈরি করা সহজ করে" বা "ব্যবহারকারীর নির্দেশিকা থেকে গ্লিফ বিভাগটি দেখুন" ।
• কাঠামোগত অসঙ্গতি পাঠকদের জন্য হতাশাজনক হতে পারে: যেমন একটি পৃষ্ঠায় ভাল-টীকাযুক্ত উদাহরণ থাকা এবং অন্য পৃষ্ঠায় উদাহরণগুলির কোনও ব্যাখ্যা নেই৷

Bokeh এর ডকুমেন্টেশন ল্যান্ডিং পৃষ্ঠাটি বরং ছোট এবং এতে সমস্ত উপলব্ধ সংস্থানগুলির তথ্য অন্তর্ভুক্ত নয় (ডকস্ট্রিং এবং মডেল সহায়তা ফাংশনের বিস্তৃত লাইব্রেরি, সমর্থন ফোরাম, ডেমো বা মিডিয়াম ব্লগের কোনও উল্লেখ নেই)। এটি নতুন ব্যবহারকারীদের জন্য Bokeh-এর সাথে শুরু করা আরও কঠিন করে তোলে।

3. লক্ষ্য

এগারো-সপ্তাহের ডক ডেভেলপমেন্ট ফেজটিকে সবচেয়ে দক্ষতার সাথে ব্যবহার করতে, আমি তিনটি মূল উপাদানের উপর ফোকাস করব:

3.1। ডক্স তৈরির উন্নতি করুন

Bokeh এর বেশিরভাগ ডকুমেন্টেশন অবদানকারীদের দ্বারা লেখা যারা নতুন কার্যকারিতা এবং বাগ ফিক্সের জন্য পুল অনুরোধের অংশ হিসাবে ডকুমেন্টেশন অন্তর্ভুক্ত করে। যদিও আমি বিদ্যমান নথিগুলি সম্পাদনা এবং রিফ্যাক্টর করার জন্য কিছু ডক ডেভেলপমেন্ট ফেজ ব্যবহার করব, আমি ডকুমেন্টেশন ভবিষ্যতের প্রমাণ তৈরি এবং বজায় রাখার জন্য ওয়ার্কফ্লো তৈরির উপর জোর দেব: অবদানকারীদের জন্য ডকুমেন্টেশনের একটি ধারাবাহিকভাবে উচ্চ মানের রাখা যতটা সম্ভব সহজ হওয়া উচিত। .

আমি দুটি পদ্ধতির সাথে এটি নিশ্চিত করব:

• বিদ্যমান বিকাশকারী গাইডে অন্তর্ভুক্ত করার জন্য আমি ব্যবহারিক, সহজ শৈলী নির্দেশিকাগুলির একটি সেট তৈরি করব। এই নির্দেশিকাগুলি শৈলী, ব্যাকরণ এবং কাঠামোকে সম্বোধন করবে। উপরন্তু, Bokeh এর অবদানকারীরা শৈলী নির্দেশিকা সম্পর্কে সচেতন কিনা তা নিশ্চিত করতে আমি স্ল্যাকের মতো অভ্যন্তরীণ যোগাযোগের চ্যানেল ব্যবহার করব। আমি দলের জন্য একের পর এক প্রশিক্ষণ এবং প্রশ্নোত্তর সেশনও অফার করব।
• ডকুমেন্টেশন কোয়ালিটি কন্ট্রোলের জন্য একটি সর্বোত্তম টুলের সেট খুঁজতে আমি মূল দলের সাথে কাজ করব, যেটি PRs (পুল রিকোয়েস্ট) এবং CI (নিরবিচ্ছিন্ন ইন্টিগ্রেশন) এর জন্য Bokeh-এর বিদ্যমান ওয়ার্কফ্লোতে যোগ করা হবে। দলের প্রয়োজনীয়তার উপর নির্ভর করে, এর অর্থ হতে পারে বোকেহ-এর টেস্টিং স্যুট, প্রি-কমিট সেটআপ বা গিটহাব অ্যাকশনে pydocstyle , proselint , বা sphinxcontrib-বানান বানান পরীক্ষা করার মতো টুল যোগ করা। আমি আমার নিজস্ব ওপেন-সোর্স প্রকল্পগুলির একটির গিটহাব অ্যাকশনে ধারণার একটি কার্যকরী প্রমাণ যোগ করেছি।

3.2। ডক্স পড়া উন্নত

ভাল ডকুমেন্টেশনের লক্ষ্য হল বর্তমান এবং সম্ভাব্য ব্যবহারকারীদের জন্য সঠিক তথ্য খুঁজে পাওয়া সহজ করা এবং যতটা সম্ভব দক্ষতার সাথে এই তথ্য ব্যবহার করতে সক্ষম হওয়া।

একটি পাঠ্যের ব্যবহারযোগ্যতার মূল কারণগুলি হল এর শৈলী এবং গঠন: একটি পরিষ্কার, সামঞ্জস্যপূর্ণ শৈলীতে ডকুমেন্টেশন লেখা পাঠকদের জন্য বিভ্রান্তি এবং অতিরিক্ত ভাষা ছাড়াই দ্রুত তথ্য সংগ্রহ করতে দেয়। ডকুমেন্টেশনের একটি সরল এবং স্বচ্ছ কাঠামো প্রাসঙ্গিক তথ্য দ্রুত খুঁজে পাওয়া সহজ করে তোলে।

আমি নতুন ব্যবহারকারীদের জন্য ব্যবহারযোগ্যতার উপর জোর দিয়ে সেই উভয় ক্ষেত্রেই ফোকাস করব। এতে ব্যবহারকারীর নির্দেশিকাকে কেন্দ্র করে বর্ণনামূলক ডকুমেন্টেশনের পুঙ্খানুপুঙ্খ পর্যালোচনা অন্তর্ভুক্ত থাকবে। আমি আরও স্পষ্টভাবে বিভিন্ন টার্গেট শ্রোতাদের সম্বোধন করতে ডকুমেন্টেশন ল্যান্ডিং পৃষ্ঠাটি ওভারহল করব এবং নিশ্চিত করব যে প্রত্যেক ব্যবহারকারী দ্রুত সঠিক সংস্থান খুঁজে পেতে পারে।

ঠিক যেমন উপরে বর্ণিত নথি তৈরির উন্নতির সাথে, আমি ভবিষ্যতের উন্নতির জন্য ভিত্তি স্থাপনের উপর ফোকাস করব এবং Bokeh-এর ডকুমেন্টেশনের জন্য ক্রমাগত উচ্চ মানের।

3.3। ডক্স শেয়ারিং উন্নত করুন

তৃতীয় পক্ষের প্ল্যাটফর্মগুলিতে বোকেহকে ঘিরে আরও বেশি আলোচনা হচ্ছে। এই প্ল্যাটফর্মগুলির মধ্যে অনেকগুলি মেটাডেটা ব্যবহার করে যেমন Facebook এর OpenGraph লিঙ্কগুলির সমৃদ্ধ পূর্বরূপ অন্তর্ভুক্ত করতে। ওপেনগ্রাফ ব্যবহার করা হয় Facebook, Twitter, LinkedIn, Slack, এবং iMessage এর মতো পরিষেবাগুলির দ্বারা৷ Bokeh এর ডিসকোর্স ফোরাম লিঙ্ক প্রিভিউ রেন্ডার করতে ওপেনগ্রাফ ব্যবহার করে।

এই প্রযুক্তি ব্যবহার করার জন্য, আমি বোকেহ-এর স্ফিঙ্কস-উত্পাদিত ওয়েব পৃষ্ঠাগুলিতে মেটাডেটা যোগ করব, যেমন সংখ্যা #9792- এ বর্ণিত হয়েছে। সবচেয়ে কার্যকর উপায় একটি ডেডিকেটেড স্ফিংস এক্সটেনশন ব্যবহার করা হবে। কিছু দিন আগে, ওপেনগ্রাফ ডেটার জন্য একটি স্ফিংস এক্সটেনশনের প্রথম সংস্করণ GitHub- এ প্রকাশিত হয়েছিল। Bokeh এর ডকুমেন্টেশনের সাথে ব্যবহারের জন্য এই এক্সটেনশনটি উন্নত করতে সাহায্য করার জন্য আমি কিছু ডক্স ডেভেলপমেন্ট ফেজ ব্যবহার করব।

আমি ধারণার একটি প্রমাণও তৈরি করেছি যেটি আমি সফলভাবে আমার নিজের একটি ওপেন-সোর্স প্রকল্প, PyPresseportal- এ ব্যবহার করছি। এই এক্সটেনশনটি স্বয়ংক্রিয়ভাবে শিরোনাম, বিবরণ, চিত্র এবং URL এর মতো প্রাসঙ্গিক তথ্য সংগ্রহ করে। তারপরে এটি এই তথ্যটি স্ফিংস-উত্পন্ন HTML-কোডে ওপেনগ্রাফ ট্যাগ হিসাবে সন্নিবেশিত করে।

এই এক্সটেনশনটি বিকাশের একটি পরবর্তী পদক্ষেপ হ'ল ওপেনগ্রাফ মেটাডেটা (ডকুটিলের বিদ্যমান 'মেটা' নির্দেশের অনুরূপ) ম্যানুয়ালি সংজ্ঞায়িত করার জন্য কাস্টম নির্দেশাবলী প্রবর্তন করা। স্বয়ংক্রিয়ভাবে তৈরি করা মেটাডেটা শুধুমাত্র একটি ফলব্যাক হিসাবে ব্যবহার করা হবে, যদি ম্যানুয়ালি প্রবেশ করা ডেটা উপলব্ধ না থাকে।

স্ট্রাকচার্ড ডেটা সমর্থন করা অনেক বেশি জটিল, তাই আমি প্রাথমিকভাবে বোকেহ-এর ডকুমেন্টেশনের জন্য উচ্চ-মানের OpenGraph মেটাডেটা অন্তর্ভুক্ত করার উপর ফোকাস করব। ওপেনগ্রাফকে সমর্থন করে এমন সমস্ত কাজ একই সময়ে, স্ট্রাকচার্ড ডেটা সমর্থনের ভিত্তি স্থাপন করবে।

Sphinx এবং ReadTheDocs সম্প্রদায়ের সদস্যরা OpenGraph এবং স্ট্রাকচার্ড ডেটার জন্য এক্সটেনশন বিকাশে আগ্রহ প্রকাশ করেছে (উদাহরণস্বরূপ #1758 এবং #5208 সমস্যাগুলিতে), এবং আমি তাদের সাথে ঘনিষ্ঠভাবে কাজ করার বিষয়টি নিশ্চিত করব।

4. বিতরণযোগ্য

সংক্ষেপে বলতে গেলে, এইগুলি হল ডেলিভারেবল যা আমি ডক্সের সিজন থেকে বেরিয়ে আসার আশা করি:

• Bokeh অবদানকারীদের জন্য ডকুমেন্টেশন শৈলী নির্দেশিকা
• স্বয়ংক্রিয় ডকুমেন্টেশন মান নিয়ন্ত্রণ অন্তর্ভুক্ত করার জন্য সংশোধিত PR এবং CI কর্মপ্রবাহ
• সম্পাদিত এবং পুনর্গঠিত ব্যবহারকারী গাইড
• সংশোধিত ডকুমেন্টেশন অবতরণ পৃষ্ঠা
• ওপেনগ্রাফ মেটাডেটা ডকুমেন্টেশন ওয়েব পেজ এবং একটি কার্যকরী Sphinx এক্সটেনশন অন্তর্ভুক্ত

এছাড়াও, আমি আমার ব্যক্তিগত ওয়েবসাইট/মাঝারি বা বোকেহ'স মিডিয়াম ব্লগে Google এর সিজন অফ ডক্সের মাধ্যমে আমার যাত্রার নথিভুক্ত করার জন্য একটি "ডকলগ" রাখব। এটি Google-এর প্রকল্প প্রতিবেদনের ভিত্তি হিসেবেও কাজ করবে। আমি GitHub সমস্যা আকারে স্বচ্ছভাবে সমস্ত কাজ করব এবং যখনই সম্ভব অনুরোধ করব।

5. সময়রেখা

সম্প্রদায়ের বন্ধন পর্বের আগে: আমি ইতিমধ্যেই Bokeh-এর GitHub সংগ্রহস্থলের বেশ কয়েকটি আলোচনায় সক্রিয়ভাবে অংশগ্রহণ করছি এবং Google-এর সিজন অফ ডক্সের জন্য বোকেহ-এর পরামর্শদাতা ব্রায়ান ভ্যান ডি ভেন এবং পবিত্র ঈশ্বরমূর্তি-এর সাথে যোগাযোগ করেছি৷ আমি বোকেহ সম্পর্কে কথোপকথনে সক্রিয় থাকব এবং ভিজ্যুয়ালাইজেশন তৈরি ও প্রকাশ করে বোকেহের সাথে নিজেকে আরও পরিচিত করব।

সম্প্রদায় বন্ধন পর্ব (08/17 - 09/13):

• মূল দলকে জানুন, পরামর্শদাতাদের সাথে বিনিময়ে প্রকল্প পরিকল্পনা পরিমার্জিত করুন
• পরামর্শদাতাদের সাথে নিয়মিত প্রতিবেদন এবং প্রতিক্রিয়ার জন্য একটি সময়সূচী এবং যোগাযোগের চ্যানেল সেট আপ করুন
• Bokeh's Slack-এ সক্রিয় থাকুন যাতে আগ্রহী Bokeh কন্ট্রিবিউটরকে Google-এর ডক্সের সিজন এবং ডক ডেভেলপমেন্ট পর্বের লক্ষ্য সম্পর্কে জানাতে
• ডক ডেভেলপমেন্ট পর্বের পরিকল্পনাকে আরও পরিমার্জিত করতে Bokeh অবদানকারীদের কাছ থেকে প্রতিক্রিয়া সংগ্রহ করুন

ডক ডেভেলপমেন্ট ফেজ

সপ্তাহ 1, 09/14 - 09/20:

• বর্ণনামূলক ডকুমেন্টেশন নিরীক্ষণ এবং সম্পাদনা শুরু করুন
• শৈলী নির্দেশিকা খসড়া শুরু করুন

সপ্তাহ 2, 09/21 - 09/27:

• শৈলী নির্দেশিকা উপর কাজ চালিয়ে যান
• বর্ণনামূলক ডকুমেন্টেশন সম্পাদনা চালিয়ে যান
• ডকুমেন্টেশন অবতরণ পৃষ্ঠা ওভারহল শুরু করুন

সপ্তাহ 3, 09/28 - 10/04:

• শৈলী নির্দেশিকা চূড়ান্ত করুন
• ডকুমেন্টেশন অবতরণ পৃষ্ঠা চূড়ান্ত করুন

সপ্তাহ 4, 10/05 - 10/11:

• বর্ণনামূলক ডকুমেন্টেশনের সম্পাদনা চূড়ান্ত করুন
• PR/CI কর্মপ্রবাহে নথির গুণমান নিয়ন্ত্রণের জন্য সরঞ্জামগুলিকে একীভূত করার বিষয়ে বোকেহ কোর টিমের সাথে আলোচনা করুন

সপ্তাহ 5, 10/12 - 10/18:

• স্ল্যাকে বোকেহ অবদানকারীদের সাথে প্রশ্নোত্তর সেশন সেট আপ করুন শৈলী নির্দেশিকা, বর্ণনামূলক ডকুমেন্টেশনের উন্নতি এবং PR/CI কর্মপ্রবাহ নিয়ে আলোচনা করতে
• ওপেনগ্রাফ মেটাডেটার জন্য আমার বিদ্যমান ধারণার প্রমাণ একটি স্থাপনযোগ্য স্ফিংস এক্সটেনশনে বিকাশ করা শুরু করুন
• Bokeh অবদানকারীদের সাথে প্রশ্নোত্তর সেশন থেকে প্রতিক্রিয়ার ভিত্তিতে শৈলী নির্দেশিকা সংশোধন করুন

সপ্তাহ 6, 10/19 - 10/25:

• পিআর এবং সিআই ওয়ার্কফ্লোতে নথির মান নিয়ন্ত্রণের জন্য সরঞ্জামগুলির পরীক্ষা শুরু করুন
• মেটাডেটার জন্য Sphinx এক্সটেনশনের বিকাশ চালিয়ে যান

সপ্তাহ 7, 10/26 - 11/01:

• স্ফিংস এক্সটেনশনের পরীক্ষা
• Slack-এ Bokeh অবদানকারীদের সাথে দ্বিতীয় প্রশ্নোত্তর সেশন
• দ্বিতীয় প্রশ্নোত্তর অধিবেশন থেকে প্রতিক্রিয়ার ভিত্তিতে বিতরণযোগ্য সংশোধন করুন

সপ্তাহ 8, 11/02 - 11/08:

• Sphinx এক্সটেনশন স্থাপন করুন এবং উন্নত বর্ণনামূলক ডকুমেন্টেশন এবং ডকুমেন্টেশন ল্যান্ডিং পৃষ্ঠা প্রকাশ করুন

সপ্তাহ 9, 11/09 - 11/15:

• পিআর এবং সিআই ওয়ার্কফ্লোতে নথির মান নিয়ন্ত্রণের সরঞ্জামগুলি স্থাপন করুন
• স্টাইল নির্দেশিকা এবং PR এবং CI ওয়ার্কফ্লো সংযোজন অন্তর্ভুক্ত করতে বিকাশকারী গাইড আপডেট এবং প্রকাশ করুন

সপ্তাহ 10, 11/16 - 11/22:

• বাকি কাজগুলো চূড়ান্ত করুন

11 সপ্তাহ, 11/23 - 11/29:

• প্রজেক্ট রিপোর্ট লেখা শুরু করুন
• প্রকল্পের মূল্যায়ন লেখা শুরু করুন

প্রকল্প চূড়ান্তকরণ পর্ব

সপ্তাহ 12, 11/30 - 12/05:

• চূড়ান্ত করা এবং প্রকল্প প্রতিবেদন জমা দেওয়া

13 সপ্তাহ, 12/03 - 12/10:

• প্রকল্প মূল্যায়ন চূড়ান্ত করুন এবং জমা দিন

Google এর ডক্সের সিজন শেষ হওয়ার পর:

• আমি আশা করি বোকেহ এর উন্নয়নে জড়িত থাকব এবং বোকেহ এর ডকুমেন্টেশন নিয়ে কাজ চালিয়ে যাব।
• আমি ওপেনগ্রাফ/স্ট্রাকচার্ড ডেটা মেটাডেটার জন্য একটি স্ফিংস এক্সটেনশনের বিকাশ চালিয়ে যাওয়ার পরিকল্পনা করছি।
• আমি আশা করি আমার পটভূমি সাংবাদিকতায় এবং আমার বিদ্যমান নেটওয়ার্ক বোকেহকে ডেটা সাংবাদিকতার একটি হাতিয়ার হিসেবে প্রচার করতে ব্যবহার করব। উদাহরণস্বরূপ, একজন সাংবাদিক শ্রোতাকে মাথায় রেখে বোকেহ সম্পর্কে লিখে বা সাংবাদিকতার সেটিংসে বোকেহ ব্যবহার করার বিষয়ে সম্মেলন আলোচনার প্রস্তাব দিয়ে।

6. আমার সম্পর্কে

আমি মূলত একজন সাংবাদিক, টিভি, অনলাইন এবং রেডিও সংবাদের পটভূমি সহ। টিভি এবং ডিজিটাল সংবাদে একজন ব্যবস্থাপনা সম্পাদক এবং প্রতিবেদক হিসাবে কাজ করা আমাকে লেখা এবং সম্পাদনার অভিজ্ঞতা দিয়েছে। একই সময়ে, আমি ডিজিটাল ট্রান্সফরমেশন এবং অটোমেশন প্রচারের বেশ কয়েকটি প্রকল্পে কাজ করেছি। আমি ডিজিটাল টুল এবং ওয়ার্কফ্লো, সেইসাথে ডিজিটাল নিউজ ব্র্যান্ডের জন্য স্টাইল গাইড এবং যোগাযোগের কৌশলগুলি কভার করে অসংখ্য ম্যানুয়াল লিখেছি। আমি সেই সরঞ্জামগুলি ব্যবহার করার জন্য দলের সদস্যদের প্রশিক্ষণ দিয়েছি।

আমি সবসময় যোগাযোগ এবং প্রযুক্তির মধ্যে ছেদ টানা হয়েছে. যখন আমি পাইথনে কোড করতে শিখেছি তখন একটি সম্পূর্ণ নতুন জগৎ আমার কাছে উন্মুক্ত হয়েছিল: উদাহরণস্বরূপ, আমি ডেটা সাংবাদিকতার জন্য ডেটা বিশ্লেষণ এবং ভিজ্যুয়ালাইজেশন করতে সক্ষম হয়েছি। কোড শেখা আমাকে নিউজরুম ওয়ার্কফ্লোগুলির জন্য ডিজিটাল সরঞ্জামগুলি বিকাশ করতে সফ্টওয়্যার ইঞ্জিনিয়ারদের সাথে সক্রিয়ভাবে একসাথে কাজ করার অনুমতি দিয়েছে।

আমার আগের চাকরিতে আমি যে ম্যানুয়াল এবং নথিগুলি লিখেছিলাম তা দুর্ভাগ্যবশত অ-সর্বজনীন। অতএব, আমি এখন ওপেন-সোর্স প্রকল্পগুলির সাথে আরও জড়িত হওয়ার দিকে মনোনিবেশ করছি (উদাহরণগুলির জন্য নীচে দেখুন)। আমি আমার কাজকে স্টাইল গাইডের উপর প্রযুক্তিগত লেখার উপর ভিত্তি করে তৈরি করেছি যেমন গুগলের ডেভেলপার ডকুমেন্টেশন স্টাইল গাইড এবং মাইক্রোসফ্ট স্টাইল গাইড। আমি নিয়মিত GitHub, Slack এবং Linux ব্যবহার করি। আমি স্ফিংক্স, মাইপি এবং স্ফিনক্স অটোডকের মতো টুল ব্যবহার করে বর্ণনামূলক ডকুমেন্টেশনের পাশাপাশি ডকস্ট্রিং এবং টাইপ ইঙ্গিত লিখছি।

আমি বর্তমানে ফ্রিল্যান্স কাজ করছি। আমার সময়সূচী ডক ডেভেলপমেন্ট পর্বে প্রতি সপ্তাহে প্রায় 25 ঘন্টা বোকেহ এর ডকুমেন্টেশনে কাজ করার জন্য প্রয়োজনীয় নমনীয়তা প্রদান করে। আমি প্যাসিফিক টাইম জোনে কাজ করি কিন্তু দলের সময়সূচী এবং চাহিদা মিটমাট করতে পেরে খুশি।

7. সাম্প্রতিক ওপেন সোর্স ডকুমেন্টেশন উদাহরণ

• PyZillow : PyZillow হল রিয়েল এস্টেট ওয়েবসাইট Zillow.com-এর API-এর জন্য একটি পাইথন মোড়ক। কিছু কোড প্রদান করা এবং কোড রক্ষণাবেক্ষণকারী হিসাবে কাজ করার পাশাপাশি, আমি সম্পূর্ণ ডকুমেন্টেশন লিখেছিলাম। আমি বর্ণনামূলক ডকুমেন্টেশন, সেইসাথে মডিউল রেফারেন্সের জন্য স্ফিংস ব্যবহার করেছি। আমি কোডে যোগ করা ডকস্ট্রিংগুলির উপর ভিত্তি করে স্ফিংস এক্সটেনশন অটোডক দিয়ে মডিউল রেফারেন্স তৈরি করেছি।

• PyPresseportal : PyPresseportal হল presseportal.de ওয়েবসাইটের API-এর জন্য একটি পাইথন মোড়ক। presseportal.de ওয়েবসাইট হল জার্মানিতে প্রেস রিলিজ এবং বিনিয়োগকারীদের সম্পর্কের ঘোষণার সবচেয়ে বড় পরিবেশক। উদাহরণস্বরূপ, প্রায় সমস্ত পুলিশ এবং ফায়ার বিভাগ তাদের প্রেস রিলিজ বিতরণ করতে এই পরিষেবাটি ব্যবহার করে। সাংবাদিক হিসাবে বহু বছর ধরে API ব্যবহার করার পরে, আমি পাইথন অবজেক্ট হিসাবে ওয়েবসাইটের ব্যাপক ডেটা সংস্থান অ্যাক্সেস করার জন্য একটি পাইথন ইন্টারফেস বিকাশ করার সিদ্ধান্ত নিয়েছি। আমি কোড এবং সম্পূর্ণ স্ফিংস-ভিত্তিক ডকুমেন্টেশন লিখেছি।