এই পৃষ্ঠায় Google সিজন অফ ডক্সের জন্য গৃহীত প্রযুক্তিগত লেখার প্রকল্পের বিশদ বিবরণ রয়েছে৷
প্রকল্পের সারসংক্ষেপ
- ওপেন সোর্স সংস্থা:
- আরডুইনো
- কৌশলী লেখক:
- AghaSaad04
- প্রকল্পের নাম:
- ডকুমেন্ট তৃতীয় পক্ষের লাইব্রেরি
- প্রকল্পের দৈর্ঘ্য:
- স্ট্যান্ডার্ড দৈর্ঘ্য (3 মাস)
প্রকল্প বর্ণনা
আমি একজন অভিজ্ঞ কারিগরি লেখক। আমি তিন বছরেরও বেশি সময় ধরে উচ্চ মানের সফ্টওয়্যার ডকুমেন্টেশন, ব্যবহারকারী-গাইড, ম্যানুয়াল, অ্যালগরিদম বিশ্লেষণ, প্রকল্প ডকুমেন্টেশন, গবেষণা পত্র লিখছি। এই প্রকল্পে, আমি সমস্ত তৃতীয় পক্ষের লাইব্রেরি নথিভুক্ত করব। আমি Arduino দ্বারা তৈরি এবং অবদান রাখা লাইব্রেরিগুলিকে নথিভুক্ত করার লক্ষ্য রাখি যাতে তাদের সমস্ত সম্ভাবনা বিকাশকারীদের কাছে উন্মোচিত হয়। আমি নিম্নলিখিত কাজগুলি সম্পন্ন করব:
লাইব্রেরির কার্যকারিতা নথিভুক্ত করুন কিভাবে লাইব্রেরিগুলিকে প্রয়োজনীয় চাহিদা মিটমাট করার জন্য উন্নত করা যায়
উদাহরণ স্বরূপ
Arduino এর NEScontroller লাইব্রেরি সত্যিই ভাল নথিভুক্ত করা প্রয়োজন. এর বৈশিষ্ট্য, সামঞ্জস্য, উদাহরণ, অ্যাপ্লিকেশনগুলি এর অবদানকারীদের জন্য এর ডকুমেন্টেশনে যুক্ত করা উচিত। ডকুমেন্টেশনে ব্যবহার ইতিমধ্যেই উল্লেখ করা হয়েছে যা আরও বেশি পরিমাণে উন্নত করা যেতে পারে। Nbiot-arduino হল NBIoT মডিউল অ্যাক্সেস করার জন্য একটি Arduino লাইব্রেরি। এর ডকুমেন্টেশন এর ব্যবহার, বিল্ড এবং টেস্ট, ডিবাগ বিকল্পগুলি প্রসারিত করে উন্নত করা যেতে পারে। কোড স্নিপেট ধারণকারী উদাহরণগুলিও অন্তর্ভুক্ত করা উচিত। Arduino-এর সবচেয়ে তারকাখচিত লাইব্রেরি ArduinoJson বিভিন্ন স্টেশনে লাইব্রেরি কীভাবে ব্যবহার করতে হয় তা দেখানোর উদাহরণ হিসেবে ভালভাবে নথিভুক্ত করা হয়েছে, প্রতিটি ক্লাস এবং ফাংশনের বিবরণ সহ API রেফারেন্স, প্রায়শই জিজ্ঞাসিত প্রশ্নাবলী যা কার্যত প্রতিটি প্রশ্নের উত্তর দেয় এবং AduinoJson সহকারী যা এর ব্যবহারকারীদের জন্য প্রোগ্রাম লেখে। ডকুমেন্টেশনে একইভাবে, সমস্ত লাইব্রেরির জন্য গভীরভাবে ডকুমেন্টেশন করা উচিত যার ডকুমেন্টেশন উন্নত এবং প্রসারিত করা প্রয়োজন। ইন্টারনেট অফ থিংস (IoT) এর ক্ষেত্রে অভিজ্ঞ হওয়ায়, আমার মাইক্রো-কন্ট্রোলার সম্পর্কে প্রাথমিক জ্ঞান রয়েছে। পাইথন, জাভা, সি, সি++, HTML5, জাভাস্ক্রিপ্ট, সি# সহ বিভিন্ন প্রোগ্রামিং ভাষায় আমার দক্ষতা রয়েছে। আমি আমার প্রযুক্তিগত লেখার দক্ষতা এবং ইলেকট্রনিক্স, মাইক্রো-কন্ট্রোলার, প্রোগ্রামিং সম্পর্কে জ্ঞানের মাধ্যমে Arduino-এ অবদান রাখতে অত্যন্ত আগ্রহী এবং ইচ্ছুক। আমি আরও শিখতে এবং আমার দক্ষতা এবং জ্ঞান বাড়াতে আগ্রহী।
সহজে ব্যবহারযোগ্য সিনট্যাক্স এবং বৈশিষ্ট্যগুলির বিস্তৃত সেটের কারণে আমি আমার সমস্ত লেখার স্টাইল করার জন্য মার্কডাউন ব্যবহার করব।
টেমপ্লেট
এটি ডকুমেন্টেশনের জন্য ব্যবহার করা যেতে পারে যে টেমপ্লেট এক. এটি সংশোধন করা যেতে পারে এবং নথির প্রয়োজনীয়তা অনুযায়ী নতুন বিভাগ যোগ করা যেতে পারে।
$projectName/Library Name
--------
In this section, I will give background information of the library,
what does this library use, on what languages and framework it is based on,
what are the dependencies of this library/project where it will be used
Features
--------
I will add features of the project here like
- this library creates connection between server and client
- Make things faster
Installation
------------
In this section I will add the installation procedure and dependencies that
needs to be installed.
Install $project by running:
install project
Contribute
----------
For the contributors, I will add this section in documentation.
- Issue Tracker: github.com/$project/$project/issues
- Source Code: github.com/$project/$project
Support
-------
This section can also be added
If you are having issues, please let us know.
We have a mailing list located at: project@google-groups.com
License
-------
This section will tell about the license of the project.
This project is licensed under the BSD.
সময় প্রতিশ্রুতি এবং যোগাযোগ
আমি সপ্তাহে 45+ ঘন্টা দেব কিন্তু কোনো দুর্ঘটনা ঘটলে, আমি সপ্তাহান্তে সেই ঘন্টাগুলিকে ক্ষতিপূরণ দেব। কমিউনিটি বন্ডের সময়কালে, আমি যোগাযোগের উপায় নিয়ে আলোচনা করব এবং আমার পরামর্শদাতার সাথে সেই মিটিংগুলির জন্য সাপ্তাহিক মিটিং, উপায় এবং সময় চূড়ান্ত করব। আমি আমার পরামর্শদাতাকে আমার কাজ সম্পর্কে আপ টু ডেট রাখব; আমার পরামর্শদাতাকে ইমেলের মাধ্যমে আমার কাজের বিবরণ শেয়ার করবে। আমি যোগাযোগের জন্য টিম ভিউয়ারকে পছন্দ করব, কারণ এটি শেয়ার স্ক্রিন ইত্যাদির মতো প্রচুর বৈশিষ্ট্যের সাথে ব্যবহার করা সহজ।
ভবিষ্যৎ পরিকল্পনা
GSoD'19 এর পর আমার ভবিষ্যৎ পরিকল্পনা খুবই স্পষ্ট। সংগঠনের অন্যান্য প্রজেক্টেও অবদান রাখব। আমি ডকুমেন্টেশন দৃষ্টিকোণ থেকে নিরাপত্তা দৃষ্টিকোণ সব দিক থেকে এটি নিখুঁত করার চেষ্টা করব. সংগঠনের যে কোনো সভায় সুযোগ পেলে অবশ্যই উপস্থিত হবো।
শর্তাবলী
আমি দৃঢ়ভাবে সম্মত যে আমি উপরে যেভাবে ব্যাখ্যা করেছি সেভাবেই কাজ করব এবং কোনও গর্ভপাতের ক্ষেত্রে, আমাকে দায়বদ্ধ করা হবে। আমি এই প্রকল্পের জন্য প্রয়োজনীয় উত্সর্গ বুঝতে পারি, আমি আপনাকে আশ্বাস দিচ্ছি যে আমি এই প্রকল্পের জন্য আমার পুরো সিজন উৎসর্গ করছি যাতে আমি সেরা কাজটি দিতে পারি।
পুরো প্রস্তাব পড়ার জন্য আপনাকে ধন্যবাদ. আরো কোন প্রশ্ন থাকলে আমার সাথে যোগাযোগ করুন.