এই পৃষ্ঠায় Google সিজন অফ ডক্সের জন্য গৃহীত প্রযুক্তিগত লেখার প্রকল্পের বিশদ বিবরণ রয়েছে৷
প্রকল্পের সারসংক্ষেপ
- ওপেন সোর্স সংস্থা:
- ওয়ার্ডপ্রেস
- কৌশলী লেখক:
- tacitonic
- প্রকল্পের নাম:
- ডকুমেন্টেশন স্টাইল গাইডের একটি সম্পূর্ণ এবং পুনর্নবীকরণ করা সেট
- প্রকল্পের দৈর্ঘ্য:
- দীর্ঘ চলমান (5 মাস)
প্রকল্প বর্ণনা
সারসংক্ষেপ:
ওয়ার্ডপ্রেস হল একটি বিশ্বব্যাপী অলাভজনক সফ্টওয়্যার সংস্থা যা বিশ্বব্যাপী সম্প্রদায়গুলিকে সফ্টওয়্যার দিয়ে পরিবেশন করার জন্য নিবেদিত যা অ্যাক্সেসযোগ্যতা, কর্মক্ষমতা, সুরক্ষা এবং ব্যবহারের সহজতার উপর জোর দেয়৷ ওয়ার্ডপ্রেস' কারণ ওয়েবে প্রকাশনা এবং ওপেন সোর্স সফ্টওয়্যারকে গণতান্ত্রিক করার চেষ্টা করে। আমাদের ডিজিটাল যুগে, একটি ওয়েবসাইট বেশ আক্ষরিক অর্থেই একটি প্রতিষ্ঠান/ব্যক্তির অনলাইন সম্মুখভাগ; এবং ওয়ার্ডপ্রেস তাদের সফ্টওয়্যার দিয়ে কয়েক মিলিয়ন ব্যবহারকারীদের দক্ষতার সাথে পরিবেশন করার একটি বিশাল কাজ করে - এটি চালানো ইন্টারনেটের 35% এর জন্য দায়ী৷ এই ব্যবহারকারীদের আরও দক্ষতার সাথে পরিবেশন করার জন্য, ডকুমেন্টেশন অপরিহার্য বলে প্রমাণিত হয় এবং বেশিরভাগ বিকাশকারী, প্রশাসক এবং শেষ ব্যবহারকারীদের দ্বারা ব্যবহৃত হয়। অতএব, ডকুমেন্টেশন ওয়ার্ডপ্রেস ইকোসিস্টেমের একটি প্রধান ফ্যাক্টর হিসাবে প্রতিষ্ঠিত হতে পারে। বর্তমান ওয়ার্ডপ্রেস ডকুমেন্টেশনে প্রকাশের জন্য সার্বজনীন এবং একীভূত নিয়ম এবং শৈলী নির্দেশিকা অন্তর্ভুক্ত নেই। এই প্রস্তাবের উদ্দেশ্য হল ওয়ার্ডপ্রেস ডকুমেন্টেশনের জন্য সর্বজনীনভাবে প্রযোজ্য ডকুমেন্টেশন শৈলী নির্দেশিকাগুলির একটি সম্পূর্ণ এবং নবায়ন করা সেট তৈরি করা। প্রজেক্ট আইডিয়ার মধ্যে ডিজাইন এবং শৈলী নির্দেশিকাগুলির সমস্ত দিক একত্রিত করা জড়িত যেমন শব্দার্থবিদ্যা, বাক্যতত্ত্ব, ব্যাকরণ নির্দেশিকা, বিরাম চিহ্ন, বিকাশ-নির্দিষ্ট নিয়ম, নকশা বৈশিষ্ট্য এবং বিন্যাস নির্দিষ্টকরণ। এটি কণ্ঠস্বর, স্বর, কাল, বক্তৃতার সমস্ত অংশ, সেইসাথে নামকরণ প্রথার মতো ভাষার রীতিগুলিও অন্তর্ভুক্ত করে। ব্যবহৃত সরঞ্জাম, ভাষা এবং প্ল্যাটফর্মগুলি হবে ওয়ার্ডপ্রেস সিএমএস, গিটহাব, মার্কডাউন এবং এতে পিএইচপি/মাইএসকিউএল, এইচটিএমএল/সিএসএস এবং জাভাস্ক্রিপ্টও থাকতে পারে।
প্রকল্প পরিকল্পনা:
ওয়ার্ডপ্রেস ডকুমেন্টেশন স্টাইল গাইডের বর্তমান অবস্থা: ওয়ার্ডপ্রেস ডকুমেন্টেশন টিম একটি অঘোষিত কিন্তু সর্বসম্মত নির্দেশিকা প্রকাশের পদ্ধতি বাস্তবায়ন করছে। কিন্তু একবারে কিছু উপাদান অনুমান করা হয় এবং প্রক্রিয়াটি অনুমানমূলক হয়ে ওঠে। ওয়ার্ডপ্রেসের জন্য নিবন্ধ লেখা এবং প্রকাশ করার উদ্দেশ্যে কোন নির্দিষ্ট মান এবং মাপকাঠি নেই। ডকুমেন্টেশন দল প্রকল্পের নির্দিষ্ট শৈলী নির্দেশিকা লিখেছে, কিন্তু কোনোটিই সর্বজনীনভাবে প্রযোজ্য নয়। বিদ্যমান বেশিরভাগ শৈলী নির্দেশিকাগুলি একটি হ্যান্ডবুকে একত্রিত করা হয় না, বা অবমূল্যায়িত হয় এবং আপডেট করা প্রয়োজন। তাই, ওয়ার্ডপ্রেস ডকুমেন্টেশনকে মানসম্মত করার জন্য একটি ইউনিফাইড স্টাইল গাইড ডিজাইন এবং ডেভেলপ করতে হবে।
উদ্দেশ্য:
ইন্টারনেটের 35% এরও বেশি ওয়েবসাইট ওয়ার্ডপ্রেসে চলে, যার ফলস্বরূপ লক্ষ লক্ষ বিকাশকারী এবং শেষ ব্যবহারকারীরা ওয়ার্ডপ্রেসের চিত্তাকর্ষক কার্যকারিতা ব্যবহার করছেন। ডকুমেন্টেশন এই ডেভেলপারদের এবং ব্যবহারকারীদের সাহায্য করার জন্য একটি অপরিহার্য উপাদান কোন অসুবিধা ছাড়াই, এমনকি অসুবিধার ক্ষেত্রেও এই কার্যকারিতাগুলি দক্ষতার সাথে পূরণ করতে। এই প্রকল্প প্রস্তাবের সামগ্রিক উদ্দেশ্য হল একটি ডিজাইন ও শৈলী নির্দেশিকাকে মানসম্মত করা, বিদ্যমান স্টাইল গাইডকে একীভূত করা এবং আপডেট করা এবং সেইসাথে ওয়ার্ডপ্রেস ডকুমেন্টেশনের জন্য নতুন প্রবিধান এবং স্পেসিফিকেশন যুক্ত করা। এটি ওয়ার্ডপ্রেস ডকুমেন্টেশনে ব্যবহারের সহজতা, সরলতা এবং অভিন্নতা সক্ষম করবে।
বাস্তবায়ন:
এই প্রকল্পের পরামর্শদাতা (জন অ্যাং) দ্বারা প্রস্তাবিত, প্রকল্পটি 4টি পর্যায়ে যোগাযোগ করা যেতে পারে: আবিষ্কার, সংজ্ঞা, বাস্তবায়ন এবং রক্ষণাবেক্ষণ পর্যায়। প্রজেক্ট শুরু করার আগে, প্রাক-ইন্টার্নশিপ সময়কালে, আমি আমার পরামর্শদাতার সাথে কাজ করব এবং আমার পরবর্তী টাইমলাইন এবং ডেলিভারেবলের লাইন ধরে একটি উপযুক্ত সময়সূচী এবং টাইমলাইন চূড়ান্ত করব। আমি এই প্রকল্পের জন্য ওয়ার্ডপ্রেস সিস্টেম এবং কাজের প্রোটোকলের সাথে নিজেকে আরও পরিচিত করব।
ইন্টার্নশিপ শুরু হওয়ার সাথে সাথে, আমি আমার পরামর্শদাতার সাথে পরিকল্পনার বিমূর্তটি নিয়ে আলোচনা করব এবং খসড়া তৈরি করব। প্রয়োজনীয়তা এবং প্রয়োজনীয়তা নির্ধারণ করা হবে। প্রথমত, আমি ডকুমেন্টেশনের প্রবাহ এবং ব্যবহারকারীর মিথস্ক্রিয়া প্রক্রিয়ার রূপরেখা দেব। পরবর্তীকালে, প্রতিটি বিভাগ, বিভাগ এবং উপাদানগুলির লেআউট ওয়্যারফ্রেমগুলি রূপরেখা দেওয়া হবে। এই লেআউটগুলি তারপর আমার পরামর্শদাতা দ্বারা পর্যালোচনা করা হবে। প্রয়োজনে, লেআউটগুলি পুনরায় ডিজাইন করা হবে এবং কিছু উপাদান যুক্ত/মুছে ফেলা হবে। তারপরে আমি ইন্টারফেস প্রবাহের ব্যবহারযোগ্যতা এবং সম্ভাব্যতা নির্ধারণের জন্য ব্যবহারকারীর গবেষণা পরিচালনা করব। পরবর্তীকালে, ডকুমেন্টেশন স্টাইল গাইড প্রতি বিভাগে প্রয়োগ করা হবে (নিচের চিত্রে চিত্রিত হিসাবে)। যে কোনো ওপেন সোর্স বা ক্রিয়েটিভ কমন্স লাইসেন্সের অধীনে থাকা অন্যান্য সংস্থার স্টাইল গাইডগুলিও আমাদের গাইড যুক্ত করতে উল্লেখ করা যেতে পারে। যদি এই সময়ের মধ্যে, ব্যবহারযোগ্যতার কোন অসুবিধা দেখা দেয়, আমি সেগুলি পুনরায় ডিজাইন করব।
স্টাইল গাইড সম্পূর্ণ হওয়ার পরে এবং হেল্পহাবের সাথে একত্রিত হওয়ার পরে পরীক্ষা এবং অপ্টিমাইজেশন করা হবে। কোন দুর্বলতা, অপ্রয়োজনীয় উপাদান বা উপাদান সংশোধন করা হবে. UI এবং কোড পরীক্ষা করা হবে এবং প্রয়োজনে অবাঞ্ছিত বাগ এবং ত্রুটিগুলি সংশোধন করা হবে। ভাষা, ব্যাকরণ, বানান, বিরাম চিহ্ন ইত্যাদির জন্য সম্পূর্ণ স্টাইল গাইডের জন্য একটি চূড়ান্ত মান নিয়ন্ত্রণ করা হবে।
অপ্রত্যাশিত বিলম্বের কারণে মুলতুবি থাকা কাজগুলি বাফার সময়ের মধ্যে সম্পন্ন হবে। অতিরিক্ত কার্যকারিতা বা বৈশিষ্ট্য যা প্রকল্পের কোর্সে সম্ভাব্য নির্ধারণ করা হবে চূড়ান্ত পরীক্ষা করার পরে বাস্তবায়িত করা যেতে পারে। একটি স্থাপনার পরিকল্পনা তৈরি করা হবে এবং সমাপ্ত পণ্য জমা দেওয়া হবে।
সরঞ্জাম এবং পদ্ধতি:
ডকুমেন্টেশনটি একটি সহযোগী প্ল্যাটফর্মে সংকলিত এবং সম্পাদনা করা হবে, যেমন Google ডক্স। GitHub এর মাধ্যমে প্রকাশ করার প্রয়োজন হলে, Markdown বা GitHub ফ্লেভারড মার্কডাউনের মতো মার্কআপ ভাষাগুলিও প্রয়োগ করা যেতে পারে। ডিজাইন এবং শৈলীর মানগুলির জন্য, ওপেন সোর্স শৈলী নির্দেশিকাগুলিও উল্লেখ করা যেতে পারে। অবশেষে, সম্পূর্ণ ডকুমেন্ট ফরম্যাট করা হবে এবং ওয়ার্ডপ্রেস ব্যবহার করে প্রকাশ করা হবে।
উপাদান টেবিল:
এটি উপাদানগুলির একটি সম্পূর্ণ তালিকা যা স্টাইল গাইডে প্রয়োগ করা যেতে পারে। নথি নির্দেশিকা - অ্যাক্সেসযোগ্যতা, নথির কাঠামো, এনকোডিং, বাহ্যিক উত্স, তথ্য, হরফ, বিশ্বব্যাপী শ্রোতা, অন্তর্ভুক্তি, বৈধতা, বহু-প্ল্যাটফর্ম অ্যাক্সেসিবিলিটি, অ-দ্ব্যর্থক, কোনও অতিরিক্ত দাবি নেই, পৃষ্ঠা বিন্যাস, রাজনৈতিক সঠিকতা, প্রোটোকল, সুরক্ষা, কাঠামো সংক্ষিপ্ত লেখা, স্বর এবং শৈলী, নিরপেক্ষ
ভাষা ও ব্যাকরণ - সংক্ষিপ্ত রূপ এবং সংক্ষিপ্ত রূপ, প্রত্যয় ও অস্বীকার, প্রবন্ধ, মূলধন, ধারা, প্রত্যক্ষ/পরোক্ষ বক্তৃতা, প্রথম/দ্বিতীয়/তৃতীয় ব্যক্তি, লিঙ্গ, শব্দকোষ, বিশেষ্য, উপসর্গ এবং প্রত্যয়, অব্যয়, সর্বনাম, রেফারেন্সিং, জ্যাগন এবং স্ল্যাং বানান, প্রযুক্তিগত পদ, কাল, ক্রিয়া, কণ্ঠ
বিরাম চিহ্ন - অ্যাপোস্ট্রফি এবং উদ্ধৃতি চিহ্ন, কোলন এবং সেমি কোলন, কমা, উপবৃত্ত, বিস্ময় চিহ্ন, হাইফেন এবং ড্যাশ, বন্ধনী, পিরিয়ড, প্রশ্ন চিহ্ন, স্ল্যাশ
বিন্যাস - বিমূর্ত, ভূমিকা, ভূমিকা, ব্র্যান্ডের নাম, পণ্যের নাম, ক্যাপশন, কোড স্নিপেট, কোড ব্লক, তারিখ ও সময়, সময় অঞ্চল, স্থান, মুদ্রা, ফাইলের নাম, পাদটীকা, শিরোনাম এবং শিরোনাম, হাইলাইটিং (বোল্ড, তির্যক, আন্ডারলাইন, স্ট্রাইকথ্রু, উদ্ধৃতি), ইন্ডেন্টেশন, ইনডেক্স, লিঙ্ক এবং ইউআরএল, তালিকা, বুলেট পয়েন্ট, সংখ্যাকরণ, মিডিয়া (ছবি, ভিডিও) এবং চিত্র, নোট, সতর্কতা, টিপস, নম্বর এবং ফোন নম্বর, পলিগ্লট, অনুবাদ, ভাষা স্ক্রিপ্ট, ফাঁকা স্থান, টেবিল , পাঠ্য, ট্রেডমার্ক, কপিরাইট, পেটেন্ট, উদ্ধৃতি, টিউটোরিয়াল এবং পদ্ধতি, UI উপাদান, পরিমাপের একক
ইউজার ইন্টারফেস - কার্যকলাপ, বোতাম, কোড স্নিপেট, কোড ব্লক, কমান্ড লাইন ইন্টারফেস, ডায়ালগ, মেনু এবং ড্রপডাউন, পপ-আপ এবং সতর্কতা, ট্যাব, পরিভাষা, UI উপাদান, উইন্ডোজ
কোড - CSS, HTML, JS, Markdown, MySQL, PHP, সিনট্যাক্স, XML
শব্দ ব্যবহার অভিধান/শব্দকোষ - A থেকে Z