ডিআইপিওয়াই প্রকল্প

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

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

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

ডিআইপিওয়াই

কৌশলী লেখক:

আরেশা তারিক

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

উচ্চ-স্তরের পুনর্গঠন এবং শেষ ব্যবহারকারীর ফোকাস

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

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

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

আমি একজন সফ্টওয়্যার ইঞ্জিনিয়ার এবং প্রযুক্তিগত লেখায় দক্ষতা আছে। উচ্চ-মানের সফ্টওয়্যার ডকুমেন্টেশন, ব্যবহারকারীর নির্দেশিকা, ম্যানুয়াল, প্রকল্পের বিবরণ লেখার ক্ষেত্রে আমার 4 বছরের বেশি অভিজ্ঞতা রয়েছে। আমি ইসলামাবাদ, পাকিস্তানে থাকি (টাইমজোন: UTC + 5)। বর্তমানে, আমি আউটরিচিতে একজন ইন্টার্ন হিসেবে কাজ করছি যা 18ই আগস্ট পর্যন্ত চলবে। আমি ওপেনএলআইএস গ্লোবাল সংস্থায় প্রযুক্তিগত লেখক হিসাবে ডক্সের Google সিজনে অংশগ্রহণ করেছি। মূল ডকুমেন্টেশন ফরাসি, সীমিত এবং পুরানো, তাই আমি ইংরেজিতে একটি বিস্তৃত এবং আপডেট করা শেষ ব্যবহারকারী ডকুমেন্টেশন তৈরি করেছি। আমি ওপেন ফুড ফ্যাক্ট সার্ভারের ব্যাকএন্ড ডেভেলপার হিসেবে মে-আগস্ট 2020-এর জন্য পার্ল অ্যান্ড রাকু সংস্থার আউটরিচি-তে নির্বাচিত হয়েছি। ব্যাক-এন্ড ডেভেলপমেন্ট ছাড়াও, এই ইন্টার্নশিপের অন্যতম প্রধান কাজ হল POD ফরম্যাটে মডিউল এবং ফাংশনের জন্য ডকুমেন্টেশন তৈরি করা। আমি গত বছর ওপেন-সোর্সের জগতে পা দিয়েছিলাম যখন আমি কয়েকটি ওপেন-সোর্স প্রকল্পে অবদান রেখেছিলাম এবং পরে ডক্সের Google সিজনে অংশ নিয়েছিলাম। এবং এই বছর, আমি আউটরিচিতে নির্বাচিত হয়েছি যা ওপেন সোর্স এবং ফ্রি সফ্টওয়্যার বৈচিত্র্যকে সমর্থন করে। আমার আউটরিচি প্রজেক্ট GitHub-এ হোস্ট করায় গিট-এর উপর আমার একটা শক্তিশালী দখল আছে এবং আমি মার্চ মাস থেকে ওপেন ফুড ফ্যাক্টস এবং মোজিলা ফেনিক্স-এ নিয়মিত অবদান রাখছি। আমি গত 3+ বছর ধরে একজন লিনাক্স ব্যবহারকারী এবং তারপর থেকে টার্মিনাল কমান্ড ব্যবহার করছি।

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

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

আমি নিম্নলিখিত কাজ করার পরিকল্পনা:

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

ব্যবহারকারীর নির্দেশিকা:

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

বিকাশকারী নির্দেশিকা:

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

টেমপ্লেট

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

DIPY-তে অবদান রাখা

• স্বাগত নোট

TOC

আচরণ বিধি

• আমাদের মান
• আচরণের উদাহরণ যা একটি ইতিবাচক পরিবেশ তৈরিতে অবদান রাখে
• অংশগ্রহণকারীদের দ্বারা অগ্রহণযোগ্য আচরণের উদাহরণ
• আমাদের দায়িত্ব
• প্রকল্প রক্ষণাবেক্ষণকারীদের দায়িত্ব
• ব্যাপ্তি

আচরণবিধির সুযোগ

সাহায্য করার জন্য আমার কী জানা দরকার?

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

উন্নয়ন পরিবেশ স্থাপন করা

এই বিভাগে, আমি ইনস্টলেশন পদ্ধতি এবং নির্ভরতা যোগ করব যা ইনস্টল করা প্রয়োজন। চালানোর মাধ্যমে $project ইনস্টল করুন: প্রকল্প ইনস্টল করুন

• সোর্স কোড: github.com/$project/$project
• ইস্যু ট্র্যাকার: github.com/$project/$project/issues

কিভাবে অবদান

কিভাবে একটি বাগ রিপোর্ট

• একটি বাগ রিপোর্ট জমা দেওয়ার আগে
• আমি কিভাবে একটি (ভাল) বাগ রিপোর্ট জমা দেব?

কিভাবে পরিবর্তন জমা দিতে হয়

• অনুরোধ প্রোটোকল টানুন
• দল থেকে প্রতিক্রিয়া
• প্রতিক্রিয়ার গতি

কিভাবে একটি বর্ধিতকরণ অনুরোধ করতে হয়

• একটি বর্ধিতকরণ সাজেশন জমা দেওয়ার আগে
• আমি কিভাবে একটি (ভাল) বর্ধিতকরণ প্রস্তাবনা জমা দেব?

আপনার প্রথম কোড অবদান

• শিক্ষানবিস সমস্যা
• সাহায্য চাই সমস্যা #### টান অনুরোধ
• টান অনুরোধ তৈরির প্রক্রিয়া
• যাচাই করুন যে সমস্ত স্ট্যাটাস চেক পাস হচ্ছে।

স্ট্যাটাস চেক ব্যর্থ হলে কি হবে?

• লেখার পরীক্ষা
• টেস্ট কভারেজ

শৈলী নির্দেশিকা

• Git কমিট বার্তা
• স্ট্যান্ডার্ড শৈলী

সমর্থন

আপনি সমস্যা হচ্ছে, আমাদের জানান. আপনার যদি সাহায্যের প্রয়োজন হয়, আপনি আমাদের মেইলিং তালিকায় প্রশ্ন করতে পারেন: [e-mail], IRC চ্যাট, অথবা [আপনার প্রকল্প ব্যবহার করে এমন অন্য কোনো যোগাযোগ প্ল্যাটফর্মের তালিকা করুন]।

লাইসেন্স

এই বিভাগটি প্রকল্পের লাইসেন্স সম্পর্কে বলবে।

সময়ের প্রতিশ্রুতি এবং যোগাযোগ:

আমি সপ্তাহে 45+ ঘন্টা দেব কিন্তু কোন দুর্ঘটনা ঘটলে, আমি সপ্তাহান্তে সেই ঘন্টাগুলি ক্ষতিপূরণ দেব। কমিউনিটি বন্ডের সময়কালে, আমি যোগাযোগের উপায় নিয়ে আলোচনা করব এবং আমার পরামর্শদাতার সাথে সেই বৈঠকগুলির জন্য সাপ্তাহিক মিটিং, উপায় এবং সময় চূড়ান্ত করব। আমি আমার পরামর্শদাতাকে আমার কাজ সম্পর্কে আপ টু ডেট রাখব; আমার পরামর্শদাতাকে ইমেলের মাধ্যমে আমার কাজের বিবরণ শেয়ার করবে। আমি যোগাযোগের জন্য টিমভিউয়ার পছন্দ করব, কারণ এটি শেয়ার স্ক্রিন ইত্যাদির মতো প্রচুর বৈশিষ্ট্যের সাথে ব্যবহার করা সহজ।