2022 কেস স্টাডি রিপোর্ট

বর্তমান পর্যায়:
ডকুমেন্টেশন উন্নয়ন. টাইমলাইন দেখুন।

ডক্সের সিজন হল Google ওপেন সোর্স প্রোগ্রাম অফিস দ্বারা পরিচালিত একটি টেকসই প্রোগ্রাম। ডক্সের মরসুমের লক্ষ্যগুলি হল:

  • ডকুমেন্টেশন সহ প্রকল্প সমস্যা সমাধানের জন্য ওপেন সোর্স প্রকল্পগুলির জন্য সমর্থন প্রদান করুন
  • প্রযুক্তিগত লেখকদের ওপেন সোর্সে অভিজ্ঞতা অর্জনের সুযোগ দিন
  • ওপেন সোর্স, ডকুমেন্টেশন এবং প্রযুক্তিগত লেখার বিষয়ে সচেতনতা বাড়ান
  • ওপেন সোর্স ডকুমেন্টেশনে কার্যকর মেট্রিক্স সম্পর্কে তথ্য সংগ্রহ এবং শেয়ার করুন

ডক্সের মরসুম সম্পর্কে আরও তথ্য প্রোগ্রামের ওয়েবসাইটে উপলব্ধ।

2022 প্রোগ্রাম ওভারভিউ

ডক্সের সিজন কিভাবে কাজ করে

ডক্সের মরসুমে, সংস্থাগুলি একটি প্রকল্প প্রস্তাব জমা দিয়ে আবেদন করে। প্রকল্প প্রস্তাব অন্তর্ভুক্ত:

  • প্রতিষ্ঠান সম্পর্কে তথ্য
  • প্রকল্পটি যে সমস্যার সম্মুখীন হচ্ছে তার বর্ণনা
  • কিভাবে প্রকল্প তাদের সমস্যা সমাধানে সাহায্য করতে ডকুমেন্টেশন ব্যবহার করবে
  • কীভাবে প্রকল্পটি তাদের ডকুমেন্টেশনের কার্যকারিতা পরিমাপ করবে (মেট্রিক্স)
  • কাজের জন্য একটি সময়রেখা
  • একটি প্রকল্প বাজেট
  • যেকোন অতিরিক্ত তথ্য, যেমন অনুরূপ প্রোগ্রামগুলিতে সংস্থার অভিজ্ঞতা, বা অন্য কিছু যা সিজন অফ ডক্স অ্যাডমিনিস্ট্রেটরদের তাদের প্রকল্প এবং সমস্যা বুঝতে সাহায্য করবে

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

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

2022 হাইলাইট

"নতুন নথি প্রকাশের পর, ক্যাসবিন এবং ক্যাসডোরে দৈনিক পরিদর্শন প্রায় দ্বিগুণ হয়ে গেছে এবং বাউন্সের হার প্রায় 30% কমে গেছে।"-ক্যাসবিন

“এই প্রকল্পের একটি আনন্দদায়ক ফলাফল [আমাদের প্রযুক্তিগত লেখকদের] আমাদের সম্প্রদায়ের নেতৃত্বের ভূমিকায় পরিণত হতে দেখছে। উভয় অবদানকারীই এখন ওয়ার্কিং গ্রুপ এবং কমিউনিটি মিটিংয়ে নেতৃত্ব দিচ্ছেন, সেইসাথে আমাদের প্রকল্পগুলির নকশা এবং রক্ষণাবেক্ষণে অবদান রাখছেন।" —মোজা-গ্লোবাল

"[GSoD] আমাদের দুইজন প্রতিভাবান প্রযুক্তিগত লেখক নিয়োগ করতে সাহায্য করেছে যা একটি নিয়মিত সেটআপে অত্যন্ত কঠিন, যারা OpenMined-এ সক্রিয় OS অবদানকারী হয়ে চলেছেন, এবং যাদের সাথে আমাদের একটি দুর্দান্ত কাজের অভিজ্ঞতা রয়েছে।" —ওপেনমাইনড

“এছাড়াও, নতুন ম্যানুয়ালটি নতুনদের জন্য গণনামূলক ভর স্পেকট্রোমেট্রিতে অনেক সহজ। এই বিষয়টিকে ব্যাখ্যা করার জন্য: CZI অনুদান ঐতিহাসিকভাবে সুবিধাবঞ্চিত ব্যক্তিদের জন্য উপবৃত্তিও প্রদান করে এবং কিছু পুরস্কারপ্রাপ্তরা তাদের ছয় সপ্তাহের ইন্টার্নশিপ সময়কাল জাম্প-স্টার্ট করার জন্য নতুন OpenMS ম্যানুয়াল ব্যবহার করেছেন এবং নতুন ম্যানুয়ালটির ইতিবাচক পর্যালোচনা দিয়েছেন।" -ওপেনএমএস

2022 সারাংশ ডেটা

2022 সালে, সিজন অফ ডক্স প্রোগ্রাম 67টি অ্যাপ্লিকেশন থেকে 31টি প্রকল্প গ্রহণ করেছে এবং 30টি প্রকল্প সফলভাবে প্রোগ্রামটি সম্পন্ন করেছে। 31টি স্বীকৃত সংস্থার মধ্যে 17টি সংস্থা পুনরাবৃত্তি আবেদনকারী ছিল।

31টি গৃহীত প্রকল্প 58 জন প্রযুক্তিগত লেখক নিয়োগ করেছে। 190 টিরও বেশি প্রযুক্তিগত লেখক ডক্স গিটহাব রেপোর সিজনে তাদের যোগাযোগের তথ্য এবং তাদের পোর্টফোলিওতে লিঙ্ক যুক্ত করে প্রোগ্রামে অংশগ্রহণে তাদের আগ্রহের ইঙ্গিত দিয়েছেন।

2022 প্রোগ্রামের জন্য:

  • 100% প্রতিষ্ঠানের আবেদন প্রক্রিয়ার সাথে একটি ইতিবাচক অভিজ্ঞতা ছিল
  • 100% সংস্থার প্রোগ্রাম ওয়েবসাইট ডকুমেন্টেশন/কন্টেন্টের সাথে একটি ইতিবাচক অভিজ্ঞতা ছিল
  • 93% সংস্থার প্রোগ্রামের সাথে একটি ইতিবাচক অভিজ্ঞতা ছিল
  • 90% সংস্থা মনে করে যে তাদের ডকুমেন্টেশন প্রকল্প সফল হয়েছে

সংগঠন সম্পর্কে

ডক্স 2022-এর সিজনে অংশগ্রহণকারী সংস্থাগুলি ওপেন সোর্স প্রকল্পের বিভিন্ন পরিসরের প্রতিনিধিত্ব করেছে। 2022 কোহর্ট অন্তর্ভুক্ত:

A bar graph showing the domains represented by the accepted projects: Data: 5 projects; Development tools: 4 projects; End-user applications: 7 projects; Hardware and robotics: 2 projects; Infrastructure and cloud: 4 projects; Programming languages and tools: 3 projects; Science and medicine: 3 projects; Security: 1 project; Social and communications: 1 project; Web tools and frameworks: 1 project

আমরা প্রকল্পগুলি সম্পর্কে কোনও মেটাডেটা সংগ্রহ করিনি (যেমন প্রতিষ্ঠার তারিখ, অবদানকারীদের ভৌগলিক বিতরণ, অবদানকারীদের সংখ্যা, বা ব্যবহারকারীর ভিত্তির আকার)।

আমরা কোন ওপেন সোর্স লাইসেন্স ব্যবহার করেছে তা নির্দেশ করতে প্রকল্পগুলিকে বলেছি।

A bar graph showing the number of projects using each OSS license: AGPL-3.0: 2 project; Apache-2.0: 9 project; BSD-3-Clause: 4 project; GPL-3.0: 3 projects; LGPL 3.0: 3 projects; MIT: 5 projects; Mozilla Public license 2.0: 2 project; BSL-1.0, GPL-2.0, LGPL-2.1: one project each

ডকুমেন্টেশন প্রকল্প সম্পর্কে

ডকুমেন্টেশন সমস্যা

2022 প্রোগ্রামে সংস্থাগুলি ডকুমেন্টেশনের সাথে সমাধান করার আশা করছিল শীর্ষ সমস্যাগুলির মধ্যে রয়েছে:

A bar graph showing the problems reported by organizations: Documentation is lacking for specific use cases of aspects of a project: 16 projects; Documentation is disorganized: 11 projects; Documentation is outdated: 7 projects; Documentation is not consistent: 1 project; Documentation needs to be converted to a different tool, platform, or format: 8 projects

মনে রাখবেন যে সংস্থাগুলি একাধিক ডকুমেন্টেশন সমস্যা রিপোর্ট করতে পারে। আরও সুনির্দিষ্ট তথ্যের জন্য, সিজন অফ ডক্স 2022 ফলাফল পৃষ্ঠা দেখুন, যা প্রতিটি সংস্থার জন্য মূল প্রকল্প প্রস্তাব এবং সম্পূর্ণ কেস স্টাডির সাথে লিঙ্ক করে।

ডকুমেন্টেশনের প্রকার তৈরি করা হয়েছে

2022 কেস স্টাডিতে কীভাবে ডকুমেন্টেশন সবচেয়ে বেশি উল্লেখ করা হয়েছে।

A chart showing the documentation types created:  How-tos: 12 projects; Tutorials: 9 projects; Reference: 8 projects; Landing page: 5 projects; API Docs: 4 projects; Diagrams, screenshots, illustrations: 4 projects; Getting Started, Style Guide, Handbook: 3 projects each; Examples, Concept documentation, user research: 2 projects each

কেস স্টাডিতে উল্লিখিত অন্যান্য ডকুমেন্টেশন প্রকার অন্তর্ভুক্ত:

  • দ্রুত শুরু
  • শব্দকোষ
  • FAQ
  • জ্ঞানভিত্তিক
  • উপাদান
  • ব্লগ/সোশ্যাল মিডিয়া কন্টেন্ট
  • রক্ষণাবেক্ষণকারী গাইড

এর মধ্যে কয়েকটি বিভাগ অস্পষ্ট এবং একটি একক ডকুমেন্টেশন প্রকল্পে একাধিক ডকুমেন্টেশন প্রকার বা বৈশিষ্ট্য থাকতে পারে।

আরও সুনির্দিষ্ট তথ্যের জন্য, সিজন অফ ডক্স 2022 ফলাফল পৃষ্ঠা দেখুন, যা প্রতিটি সংস্থার জন্য মূল প্রকল্প প্রস্তাব এবং সম্পূর্ণ কেস স্টাডির সাথে লিঙ্ক করে।

বাজেট

গড় বাজেট অনুরোধ ছিল $11,679 এবং মধ্যম ছিল $12,150। পাঁচটি সংস্থা অনুরোধ করেছে এবং সর্বোচ্চ উপলব্ধ অনুদান ($15k) পেয়েছে এবং তিনটি সর্বনিম্ন ($5k-$7K এর মধ্যে) অনুরোধ করেছে।

মেট্রিক্স

তাদের ক্ষেত্রে বর্ণিত প্রকল্পগুলি তাদের ডকুমেন্টেশন প্রকল্পগুলির সাফল্যের পরিমাপ করতে তারা যে মেট্রিকগুলি ব্যবহার করেছিল তা অধ্যয়ন করে।

শীর্ষ প্রস্তাবিত মেট্রিক্স ছিল:

A bar graph showing documentation success metrics: More contributors/pull requests: 12 projects; Total percentage of target info covered by docs: 8 projects; Fewer project issues/questions: 7 projects; More visitors to documentation/docs usage: 6 projects;  Better SEO: 5 projects; Increased documentation satisfaction (via survey), Increased project use, More GitHub stars/forks: 3 projects each; Total number of docs created and Qualitative user testing: two projects each

অন্যান্য প্রস্তাবিত মেট্রিক্স অন্তর্ভুক্ত:

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

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

আমরা 2023 সালে ফলোআপ সমীক্ষার উত্তর পাওয়ার সাথে সাথে কোন প্রকল্পগুলি তাদের মেট্রিকগুলি অর্জন করেছে বা তাদের মেট্রিক্স সংশোধন করেছে সে সম্পর্কে তথ্য যোগ করতে আমরা এই প্রতিবেদনটি আপডেট করব।

আরও সুনির্দিষ্ট তথ্যের জন্য, সিজন অফ ডক্স 2022 ফলাফল পৃষ্ঠা দেখুন, যা প্রতিটি সংস্থার জন্য মূল প্রকল্প প্রস্তাব এবং সম্পূর্ণ কেস স্টাডির সাথে লিঙ্ক করে।

প্রযুক্তিগত লেখকদের সাথে কাজ করা

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

ওপেন সোর্স প্রকল্পের জন্য প্রযুক্তিগত লেখক নিয়োগের জন্য সর্বোত্তম অনুশীলন

প্রযুক্তিগত লেখকদের নিয়োগ, নিয়োগ এবং কাজ করার জন্য প্রকল্পগুলিকে তাদের সেরা অনুশীলনগুলি ভাগ করে নিতে বলা হয়েছিল৷ শীর্ষ সুপারিশ ছিল:

নিয়োগের

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

নিয়োগ

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

সমন্বয় এবং যোগাযোগ

  • প্রজেক্টে কাজ করা প্রত্যেকের জন্য প্রেক্ষাপট এবং পরবর্তী পদক্ষেপগুলি বুঝতে সহজ করার জন্য একটি মিটিং লগ রেকর্ডিং সিদ্ধান্ত রাখুন
  • কি যোগাযোগ প্রত্যাশিত এবং কত ঘন ঘন, এটি সাপ্তাহিক কল, দৈনিক ইমেল, বা একটি চ্যাট চ্যানেলে স্ট্যাটাস আপডেট কিনা সে সম্পর্কে পরিষ্কার থাকুন
  • প্রতিক্রিয়াশীল হন এবং স্পষ্ট প্রতিক্রিয়া দিন যাতে 'কেন' অন্তর্ভুক্ত থাকে এবং কেবল 'কী' নয়
  • আপনার প্রযুক্তিগত লেখকদের প্রসঙ্গ দিতে এবং তাদের কাজের সামাজিকীকরণের জন্য বিস্তৃত সম্প্রদায়ের সাথে সংযুক্ত করুন

প্রসেস এবং টুলিং

  • একটি ডকুমেন্টেশন প্রক্রিয়া তৈরি করুন যা দস্তাবেজ প্রোগ্রামের মরসুমের বাইরে স্থায়ী হবে এবং সমগ্র সম্প্রদায় এতে অবদান রাখতে পারে
  • ডকুমেন্টেশন পর্যালোচনা অন্তত ততটা সময় লাগবে এবং কোড পর্যালোচনার মতোই নিবিড়; নিশ্চিত করুন যে আপনি এটির জন্য যথেষ্ট সময় দিয়েছেন

কিছু সুপারিশ সম্পাদনা করা হয়েছে এবং স্পষ্টতার জন্য ঘনীভূত করা হয়েছে।

2021 প্রোগ্রামের মতো, ডক্স 2022 এর সিজনে বেশিরভাগ প্রযুক্তিগত লেখকরা তাদের সাথে কাজ করা সংস্থাগুলিতে সরাসরি আবেদন করেছিলেন৷

A bar graph showing the source of technical writer candidates: Applied directly to program: 18; SoD GitHub or previous SoD participant: 6; Community member: 5; Not specified: 3; Applied via jobs site: 1

প্রযুক্তিগত লেখকদের সাথে কাজ করার ক্ষেত্রে সাধারণ সমস্যা

A bar graph showing technical writer issues: TW dropping out: 4 projects; Communications issues, TW onboarding, TW skills, Lack of domain knowledge, Hardware confiscated, Conflict with other ongoing work: 1 project each

কম প্রকল্প 2022 প্রোগ্রামে তাদের প্রযুক্তিগত লেখকদের সাথে কাজ করার সমস্যাগুলি রিপোর্ট করেছে। কারিগরি লেখকদের প্রোগ্রামটি সম্পূর্ণ করতে অক্ষম হওয়া সবচেয়ে বড় সমস্যা ছিল, অসুস্থতার কারণে, একটি পূর্ণ-সময়ের চাকরি নেওয়া বা সময়ের প্রতিশ্রুতি পূরণ করতে অক্ষম।

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

ফলোআপ সমীক্ষা

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

ভবিষ্যতের প্রশ্ন

বরাবরের মতো, ওপেন সোর্সে ডকুমেন্টেশন সম্পর্কে আমরা যত বেশি শিখি, ততই আমরা শিখতে চাই!

ভবিষ্যতের মরসুমে, আমরা আশা করি:

  • প্রকল্পের বয়স, সম্প্রদায়ের আকার, বা ভাষা এবং ডকুমেন্টেশন প্রয়োজনের মধ্যে পারস্পরিক সম্পর্ক খুঁজতে আরও প্রকল্প মেটাডেটা সংগ্রহ করুন
  • ভাগ করা যায় এমন টেমপ্লেটগুলিতে সাধারণীকরণ করা যায় কিনা তা দেখতে ডকুমেন্টেশন প্রকল্পগুলি বিশ্লেষণ করুন
  • ওপেন সোর্স প্রকল্পে প্রযুক্তিগত লেখকদের সাক্ষাৎকার নেওয়ার জন্য একটি রুব্রিক তৈরি করুন

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