কলিব্রি প্রকল্প

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

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

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

কলিবরি

প্রযুক্তিগত লেখক:

স্টেফডিক্স

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

কলিব্রি ইকোসিস্টেম ডকুমেন্টেশন স্টাইল এবং ওয়ার্কফ্লো কনভেনশন

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

দীর্ঘ চলমান (5 মাস)

প্রকল্পের বিবরণ

বিমূর্ত

এই নথিতে কলিব্রি ইকোসিস্টেম প্রকল্পের জন্য লার্নিং ইকুয়ালিটির নথিভুক্ত তথ্যে শৈলী নির্দেশিকা এবং কর্মপ্রবাহ ব্যবস্থাপনার বাস্তবায়নের বিবরণ রয়েছে।

ওভারভিউ

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

উদ্দেশ্য এবং সুযোগ

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

শ্রোতা

বাস্তবায়নকারী, প্রশাসক এবং শেষ ব্যবহারকারীদের প্রাথমিক শ্রোতা হল কলিব্রি ডকুমেন্টেশনের সবচেয়ে গুরুত্বপূর্ণ ভোক্তা। কলিব্রি ডকুমেন্টেশন তৈরি এবং ব্যবহারের জন্য দলের সদস্য এবং সহযোগীদের একটি মাধ্যমিক দর্শক।

উদ্দেশ্য

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

তথ্যের উৎস

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

সফটওয়্যার

আমি Google ডক্সে স্টাইল গাইডের খসড়া তৈরি করব। এই ডকুমেন্ট প্ল্যাটফর্মটি প্রকাশের জন্য প্রস্তুত থাকাকালীন পুনরাবৃত্তি করার জন্য উপযুক্ত। QA অডিটের জন্য, আমি নথিগুলি পরিচালনা এবং মূল্যায়ন করতে Google ফর্মগুলি ব্যবহার করব৷ একটি স্প্রেডশীট নথি নিয়ন্ত্রণের জন্য ফর্ম প্রতিক্রিয়া সংরক্ষণ করবে। আমি GitHub ব্যবহার করে RTD নথিগুলি রিফ্যাক্টর করব। আমি Git, Gitkraken, GitHub এবং Gitlab এর সাথে কাজ করেছি। আমার মার্কডাউন এবং কয়েকটি পুনর্গঠিত পাঠ্য সম্পর্কে কাজের জ্ঞান রয়েছে। আমি সিনট্যাক্স শেখা চালিয়ে যেতে ডকুমেন্টেশন ফিক্সে অবদান রাখার পরিকল্পনা করছি। আমি ছবি এবং gif এর জন্য Sharex ব্যবহার করব। আমি এই টুলটি পছন্দ করি কারণ এটি বিভিন্ন আউটপুট ফরম্যাটে রেন্ডার করে। আমি ডায়াগ্রামিং এবং ইমেজ সংস্করণের জন্য ডায়াগ্রাম ব্যবহার করব। ডায়াগ্রাম সফ্টওয়্যার GoogleDocs, Google Drive, এবং LibreOffice-এর সাথে সুন্দরভাবে সংহত করে। ডকুমেন্টেশনের অবস্থা অন্বেষণ পর্বে, আমি কলিব্রির বেশিরভাগ ডকুমেন্টেশন সংশোধন করেছি। আমি ব্যাকরণগত ত্রুটি, টাইপো, বিন্যাসে অসঙ্গতি, টাইপোগ্রাফি, চিত্রের ব্যবহার এবং এছাড়াও, প্রকল্পের বেশিরভাগ ডকুমেন্টেশন থেকে বিভ্রান্তিকর ডকুমেন্টেশন পাথ খুঁজে পেয়েছি। উদাহরণ স্বরূপ, কলিব্রির ইউজার গাইডে, সমস্যা সমাধান বিভাগটি একটি উপবিষয়ক এবং একটি বিষয় নয়। শেষ ব্যবহারকারীদের বিষয়বস্তুর সারণী থেকে এটি অ্যাক্সেস করার জন্য এই তথ্যটি যথেষ্ট গুরুত্বপূর্ণ। দ্বিতীয় বিকল্প হিসাবে, তারা অন্যান্য বিষয় প্রসারিত করতে এবং সমস্যা সমাধানের নিবন্ধগুলি সনাক্ত করতে অনুসন্ধান বার এবং বিষয়বস্তুর সারণী ব্যবহার করতে পারে।

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

ফলাফল

আমি একটি প্রাথমিক ফর্মের সাথে পরামর্শ এবং মন্তব্য ছাড়াও LE অনুবাদ গাইডে একটি গুণমান পরীক্ষা করেছি যা আমি QA অডিট টাস্কে আরও বিশদভাবে ব্যাখ্যা করেছি। এগুলি মূল্যায়ন থেকে প্রাপ্ত কিছু চূড়ান্ত মন্তব্য: ICU সিনট্যাক্স .js ওয়েবসাইটের জন্য ভাঙা লিঙ্কগুলি এই নির্দেশিকাগুলি তৈরি করতে ব্যবহৃত ফর্ম্যাটটি ভুল। নথিটি একটি নির্দেশিকা, নির্দেশিকা নয়। অসংলগ্ন টাইপোগ্রাফি। শিরোনাম এবং শিরোনামের ভুল ব্যবহার, ভাষার অনুপযুক্ত ব্যবহার এবং সংকোচনের অপব্যবহার। বিকল্প পাঠ্যের অনুপযুক্ত ব্যবহার। বারবার বিবৃতি / নির্দেশাবলীর উপর।

উভয় নথির ফলাফল এই প্রস্তাবের জন্য বিতরণযোগ্য অংশ।

প্রকল্প-নির্দিষ্ট কাজ

• LE ব্যবহারকারী ডকুমেন্টেশন স্টাইল গাইড সুপারিশ (মন্তব্য)
• নতুন শৈলী এবং বিন্যাস সহ LE অনুবাদ নির্দেশিকা।
• বিষয় রূপরেখা
• প্রকল্পের সময়রেখা
• ডকুমেন্টেশন কাজ