এই পাতায় গুগল সিজন অফ ডকস-এর জন্য গৃহীত একটি টেকনিক্যাল রাইটিং প্রজেক্টের বিবরণ রয়েছে।
প্রকল্পের সারসংক্ষেপ
- ওপেন সোর্স সংস্থা:
- লিনাক্স ফাউন্ডেশন
- প্রযুক্তিগত লেখক:
- বোরন
- প্রকল্পের নাম:
- ডকুমেন্টেশন হোস্টিং ও জেনারেশন পুনর্গঠন করুন এবং গেটিং স্টার্টেড পেজ ও ডেভেলপার গাইডগুলোর কাঠামো পুনর্নির্মাণ করুন।
- প্রকল্পের দৈর্ঘ্য:
- সাধারণ দৈর্ঘ্য (৩ মাস)
প্রকল্পের বিবরণ
সারসংক্ষেপ :
ডকুমেন্টেশনের উদ্দেশ্য হলো ব্যবহারকারী এবং ডেভেলপারদের কোনো পণ্য বা পরিষেবা ব্যবহারে সহায়তা করা। ভালো ডকুমেন্টেশন অত্যন্ত গুরুত্বপূর্ণ, কারণ এটি ব্যবহারকারীদের একটি সফটওয়্যার কীভাবে ব্যবহার করতে হয়, এর বৈশিষ্ট্য, বিভিন্ন টিপস ও ট্রিকস সম্পর্কে জানতে এবং সফটওয়্যারটি ব্যবহারের সময় সম্মুখীন হওয়া সাধারণ সমস্যাগুলো সমাধান করতে সাহায্য করে। এটি সাপোর্টের খরচও কমায় এবং পণ্যটির কর্পোরেট ও ওপেন সোর্স পরিচয়ের একটি অংশ হিসেবে কাজ করে। একটি ভালো ডকুমেন্টেশন পণ্য এবং ডেভেলপার দলের সুস্থতার পরিচায়ক।
ভালো ডকুমেন্টেশন ছাড়া, একজন ব্যবহারকারী হয়তো উপরের কাজগুলো কীভাবে কার্যকর ও দক্ষতার সাথে করতে হয় তা জানতে পারবেন না। একটি পণ্যের সাফল্য নিশ্চিত করতে ডকুমেন্টেশন একটি অত্যন্ত গুরুত্বপূর্ণ ভূমিকা পালন করতে পারে, কারণ চমৎকার যোগাযোগ যেকোনো ব্যবসা বা পণ্যের কেন্দ্রবিন্দুতে রয়েছে এবং থাকবে। আর একটি ভালো ডকুমেন্টেশন সেই যোগাযোগকেই একটি সহজবোধ্য কাঠামোতে উপস্থাপন করে, যা সাফল্যের জন্য সকলের কাছে সহজলভ্য হয়।
প্রতিটি ডকুমেন্টেশন সাইটের জন্য একটি ভালো নির্মাণ ও হোস্টিং ওয়ার্কফ্লো পাইপলাইন প্রয়োজন। AGL-এর মতো একটি প্রতিষ্ঠানে, যেখানে একাধিক সংস্করণ এবং প্রচুর বিশদ ডকুমেন্টেশন রয়েছে, সেখানকার ডকুমেন্টেশন ফাইলগুলো (মার্কডাউন) একাধিক রিপোজিটরিতে ছড়িয়ে ছিটিয়ে থাকে, যা সেগুলোর রক্ষণাবেক্ষণ এবং হালনাগাদ করার কাজকে অত্যন্ত জটিল ও সময়সাপেক্ষ করে তোলে।
বর্তমান অবস্থা :
- এজিএল ডক ওয়েবসাইটটি বিভিন্ন রিপোজিটরি থেকে সংগৃহীত মার্কডাউন ফাইলের একটি সংকলনের উপর ভিত্তি করে তৈরি।
- ডক পেজগুলো বর্তমানে কর্ডোভা প্রজেক্টের ইঞ্জিন ব্যবহার করে স্বতন্ত্র সোর্সগুলোর মধ্যে মার্কডাউন হিসেবে হোস্ট করা আছে।
- এর ফলে ডকুমেন্টেশন তৈরি এবং হোস্টিং প্রক্রিয়ার জন্য চারটি রিপোজিটরি সেটআপ করা হয়:
- Docs-webtemplate [https://github.com/automotive-grade-linux/docs-webtemplate] : এতে জেকিল ওয়েবসাইট টেমপ্লেটটি রয়েছে।
- ডকস-টুলস [https://github.com/automotive-grade-linux/docs-tools] : মার্কডাউন ফাইল থেকে স্বয়ংক্রিয়ভাবে একটি প্রযুক্তিগত ওয়েবসাইট তৈরি করার টুলস এতে রয়েছে।
- ডক্স-সোর্স [https://github.com/automotive-grade-linux/docs-sources] : সাধারণ ডকুমেন্ট ও গাইডের জন্য উৎস (মার্কডাউন [https://github.com/automotive-grade-linux/docs-sources/tree/master/docs])।
- Docs-gh-pages [https://github.com/automotive-grade-linux/docs-gh-pages] : ডকুমেন্টেশন সাইট [https://gist.github.com/growupboron/docs.automotivelinux.org]-এর জন্য গিটহাব পেজেস রিপোজিটরি ডেপ্লয় করা হয়েছে।
- docs-tools [https://github.com/automotive-grade-linux/docs-tools]-এ উপলব্ধ একটি টুল (স্ক্রিপ্ট) docs-webtemplate [https://github.com/automotive-grade-linux/docs-webtemplate]-এ অবস্থিত fetched_files.yml অনুযায়ী সমস্ত মার্কডাউন ফাইল সংগ্রহ এবং টেমপ্লেটিং করার কাজটি করে।
- এজিএল ডকুমেন্টেশন ওয়েবসাইট তৈরির বর্তমান কার্যপ্রবাহ : current_workflow [https://drive.google.com/file/d/1OSwkVWFcsajgCOjbtdPf42EIfpidUJ0U/view?usp=sharing]
- section_version.yml-এ সমস্ত বইয়ের yaml ফাইলের লিঙ্ক থাকে এবং এটি রিমোট রিপোজিটরি থেকে সমস্ত বইয়ের yaml ফাইল docs-webtemplate [https://github.com/automotive-grade-linux/docs-webtemplate]-এ ফেচ করে। বইয়ের yaml ফাইলগুলোতে রিমোট রিপোজিটরি থেকে আপনার মার্কডাউন ফাইলগুলোর সমস্ত ইউআরএল থাকে।
- সমস্ত মার্কডাউন ফাইল ফেচ করা হয়ে গেলেই, টুলটি docs-gh-pages [https://github.com/automotive-grade-linux/docs-gh-pages]-এ AGL ডক ওয়েবসাইটটি তৈরি করার প্রক্রিয়া শুরু করে, যা যথাযথভাবে ডেপ্লয় করা হয়।
- পাইপলাইন রক্ষণাবেক্ষণের বর্তমান প্রক্রিয়াটি ব্যবহারকারী এবং ডেভেলপার-বান্ধব নয়, বিশেষ করে নতুন অবদানকারীদের জন্য। এই ওয়ার্কফ্লো পাইপলাইনটিকে (বিল্ডিং এবং হোস্টিং-এর) আরও অনেক বেশি সরল ও সুবিন্যস্ত করা যেতে পারে, যাতে ডেভেলপাররা ডকুমেন্টেশন তৈরি এবং ডেপ্লয়মেন্ট ওয়ার্কফ্লো রক্ষণাবেক্ষণের পরিবর্তে ডকুমেন্টেশন অংশের উপর মনোযোগ দিতে পারেন।