এই পৃষ্ঠায় Google সিজন অফ ডক্সের জন্য গৃহীত প্রযুক্তিগত লেখার প্রকল্পের বিশদ বিবরণ রয়েছে৷
প্রকল্পের সারসংক্ষেপ
- ওপেন সোর্স সংস্থা:
- ভিএলসি
- কৌশলী লেখক:
- আভি
- প্রকল্পের নাম:
- একটি মোবাইল পোর্টের জন্য ভিএলসি ইউজার ডকুমেন্টেশন তৈরি করুন (অ্যান্ড্রয়েড)
- প্রকল্পের দৈর্ঘ্য:
- স্ট্যান্ডার্ড দৈর্ঘ্য (3 মাস)
প্রকল্প বর্ণনা
বিমূর্ত
ব্যবহারকারী ডকুমেন্টেশন শেষ ব্যবহারকারীদের সহায়তা করার জন্য একটি স্ট্যাটিক সমর্থন সিস্টেম হিসাবে ব্যবহৃত হয়। এটি একটি পণ্য বা পরিষেবা সম্পর্কে প্রযুক্তিগত এবং অ-প্রযুক্তিগত উভয় তথ্য প্রদান করে। এটি ব্যবহারকারীদের কীভাবে সফ্টওয়্যার বা পরিষেবা ব্যবহার করতে হয় তা শিখতে সাহায্য করে৷ প্রত্যেক ব্যক্তি সমর্থনের সাথে যোগাযোগ করতে চায় না বা একটি ইমেলের উত্তরের জন্য অপেক্ষা করতে চায় না যদি তার প্রয়োজন হয় সামান্য দিকনির্দেশনা, টিপস বা কৌশল। ব্যবহারকারী ডকুমেন্টেশন শুধু যে করে. এটি সহায়তা খরচও হ্রাস করে এবং এটি পণ্যের স্বাস্থ্য এবং বিকাশকারী দলের একটি পরিচয়।
অ্যান্ড্রয়েডের জন্য ভিএলসি শুধুমাত্র গুগল প্লে স্টোর থেকে 100 মিলিয়ন বার ডাউনলোড করা হয়েছে। ভিএলসি তার মোবাইল পোর্টের জন্য অডিও-ভিডিও প্লেব্যাক থেকে শুরু করে নেটওয়ার্ক স্ট্রীম পর্যন্ত প্রচুর বৈশিষ্ট্য সরবরাহ করে। প্রায়শই লোকেরা এই দুর্দান্ত বৈশিষ্ট্যগুলি ব্যবহার করতে চায় তবে তারা তা করতে অক্ষম হয়। এটির জন্য একটি ব্লগ বা কিছু এলোমেলো ভিডিও অনুসন্ধান করার জন্য অনেক সময় এবং ধৈর্যের প্রয়োজন এবং এখনও, প্রাপ্ত তথ্যের কোন সত্যতা নেই। বর্তমানে, ভিএলসি উইকি পৃষ্ঠায় অ্যান্ড্রয়েড ব্যবহারকারী ডকুমেন্টেশনের জন্য ভিএলসি হোস্ট করে এবং এই বৈশিষ্ট্যগুলির কম বা কোন বিবরণ প্রদান করে না। তা ছাড়াও, উইকি পৃষ্ঠাগুলি সর্বশেষ আপডেট করা হয়েছিল মার্চ 2019 এ। বর্তমান প্রকল্পটি একটি আধুনিক ডিজাইন এবং অ্যান্ড্রয়েড পোর্টের জন্য ব্যবহারে আরও সহজতার সাথে নতুন ব্যবহারকারীর ডকুমেন্টেশন প্রদান করবে।
বর্তমান পরিস্থিতি
উইকি পৃষ্ঠাগুলি সম্পূর্ণ পুরানো এবং VLC এর সর্বশেষ সংস্করণ সম্পর্কে খুব কম তথ্য রয়েছে। এছাড়াও, তারা নেভিগেট করা সহজ নয়। ইংরেজি ছাড়া অন্য ভাষায় ডকুমেন্টেশন পড়ার কোন দৃশ্যমান বিকল্প নেই। এতে বৈশিষ্ট্যের বর্ণনা নেই।
বিশ্লেষণ
-> এখন পর্যন্ত বর্তমান ডকুমেন্টেশন অপ্রচলিত এবং একটি নতুন উপায়ে এবং একটি ভিন্ন প্ল্যাটফর্ম এবং সরঞ্জাম ব্যবহার করে লিখতে হবে।
-> বেশিরভাগ অ্যান্ড্রয়েড ব্যবহারকারীর প্রযুক্তিগত জ্ঞান কম বা নেই। কিন্তু এমন কিছু লোক রয়েছে যাদের একটি বৈশিষ্ট্য সম্পর্কে আরও প্রযুক্তিগত তথ্য প্রয়োজন। উপরের প্রতিটি উদ্দেশ্যে দুটি পৃথক ডকুমেন্টেশন লেখা এবং বজায় রাখা ভাল ধারণা নয়। অথবা এমনকি একই ডকুমেন্টেশনে প্রযুক্তিগত এবং অ-প্রযুক্তিগত উপর ভিত্তি করে একটি বৈশিষ্ট্য বিভাজন অতিরিক্ত বিভ্রান্তি তৈরি করে। কারণ আবারও বেশিরভাগ ব্যবহারকারী তাদের দেখেন বা তারা যে বৈশিষ্ট্যগুলি ব্যবহার করেন তাতে অভ্যস্ত, তাই কিছু প্রযুক্তিগত বা অ-প্রযুক্তিগত কিনা তা নির্ধারণ করা সবার পক্ষে সহজ নয়। তাই আমরা তাদের জন্য এই সহজ করতে চাই.
-> বেশিরভাগ ব্যবহারকারী তাদের স্মার্টফোনের মাধ্যমে তথ্য পাওয়ার চেষ্টা করবেন এবং ডেস্কটপ বা অন্যান্য ডিভাইসের মাধ্যমে বিশ্রাম নেবেন। তাই ডকুমেন্টেশন প্রতিটি স্ক্রীন আকারের সাথে সহজেই মানিয়ে নেওয়া উচিত। এবং নেভিগেশন সম্পর্কে কোন বিভ্রান্তি তৈরি করবে না।
-> ডেস্কটপ সংস্করণের প্রতিটি বৈশিষ্ট্য অ্যান্ড্রয়েড পোর্টে উপলব্ধ নয় এবং উপলব্ধ থাকলে উভয় পোর্টে একই কাজ করে না। এর কারণ হল ডেস্কটপ অ্যাপ্লিকেশনটি অনেক দিন ধরে বিকাশের মধ্যে রয়েছে এবং এটি এক ধরণের স্যাচুরেশন অবস্থা অর্জন করেছে, বিপরীতে মোবাইল পোর্ট তুলনামূলকভাবে নতুন এবং এখনও বিকাশমান। তা ছাড়া, যদিও বর্তমানে মোবাইল ডিভাইসগুলি এত শক্তিশালী হয়ে উঠছে, তবে শেষ ব্যবহারকারীর চাহিদার কারণে আমরা বেশিরভাগ বৈশিষ্ট্য অন্তর্ভুক্ত করতে পারি তার উপর স্পষ্ট সীমাবদ্ধতা রয়েছে। এমন একটি বৈশিষ্ট্য থাকা যা কেউ ব্যবহার করে না তা উন্নয়ন সম্পদের অপচয়। তাই বৈশিষ্ট্যের ভিত্তিতে উভয় ডকুমেন্টেশন কথোপকথন সুপারিশ করা হয় না।
উপরের বিশ্লেষণের উপর ভিত্তি করে আমি নিম্নলিখিত প্রস্তাব করছি। 1. এখন পর্যন্ত ডেস্কটপ ব্যবহারকারী ডকুমেন্টেশন স্ফিংস ডকুমেন্টেশন জেনারেটর ব্যবহার করছে এবং ডক্স থিম পড়ুন। অ্যান্ড্রয়েড পোর্টের জন্য একই ব্যবহার আমাদের নিম্নলিখিত উপায়ে সাহায্য করবে: -> উভয় ডকুমেন্টেশনের সহজে একত্রীকরণ। -> এটি সমস্ত পর্দার আকারের জন্য অপ্টিমাইজ করা হয়েছে। -> ডেস্কটপ ডকুমেন্টেশনের মাধ্যমে অ্যান্ড্রয়েড ব্যবহারকারী ডকুমেন্টেশনে নেভিগেট করার সময় বিরামহীন অভিজ্ঞতা
- প্রয়োগের ক্ষেত্রে তাদের আপেক্ষিক অবস্থান অনুযায়ী অধ্যায়, বিভাগ এবং উপধারা আলাদা করা। যেমন- ব্যাকগ্রাউন্ড/পিআইপি মোড আরও -> সেটিংস->ভিডিওর ভিতরে রয়েছে, তাই অধ্যায়ের কাঠামো হবে
- আরও
- |__সেটিংস
- | |__মিডিয়া লাইব্রেরি
- | |__ভিডিও -->ব্যাকগ্রাউন্ড/পিআইপি মোড
- : -> এই পদ্ধতিটি অ্যাক্সেসের সহজলভ্যতাকে উন্নত করবে কারণ ব্যবহারকারীরা অ্যাপ্লিকেশনের আপেক্ষিক অবস্থানের সাথে তুলনা করে সহজেই সেই অংশে নেভিগেট করতে সক্ষম হবেন যেখানে তাদের সহায়তা প্রয়োজন। প্রতিটি বৈশিষ্ট্যের জন্য আমরা প্রযুক্তিগত এবং অ প্রযুক্তিগত অংশগুলিকে আরও আলাদা করতে পারি। আমরা প্রথমে একটি অ-প্রযুক্তিগত সহজ বিবরণ লিখব এবং তারপরে একই বৈশিষ্ট্যের প্রযুক্তিগত অংশগুলিকে আরও হাইলাইট বা লেবেল করব, যদি থাকে, তবে এটির ঠিক নীচে। এটি কিছু পুনরাবৃত্তির দিকে পরিচালিত করতে পারে তবে এটি অ-প্রযুক্তিগত সংখ্যাগরিষ্ঠের মসৃণ অভিজ্ঞতা নিশ্চিত করবে। এটি রক্ষণাবেক্ষণযোগ্যতা বৃদ্ধি করে ভবিষ্যতে ভবিষ্যতেও সাহায্য করবে। যেহেতু অ্যাপ্লিকেশনটি স্যাচুরেশন অবস্থায় পৌঁছাবে আপেক্ষিক UI এর খুব বেশি পরিবর্তন হওয়ার সম্ভাবনা নেই, তাই ভবিষ্যতে যদি একটি নতুন বৈশিষ্ট্য যুক্ত/মুছে ফেলা হয় তবে আমরা কেবল বিভাগটিকে রিফ্যাক্টর করতে পারি। যদি পুরো UI পরিবর্তন করা হয়, আমরা বিভাগ/অধ্যায়গুলিকে পুনর্বিন্যাস করতে পারি বা পুরো ডকটিকে পুনর্গঠন করতে পারি, উভয় ক্ষেত্রেই আমাদের পুরো ডকুমেন্টেশন পরিবর্তন করতে হবে কারণ বর্তমান UI-এর সাথে মেলে স্ক্রিনশটটি প্রতিস্থাপন করতে হবে। একটি কাজের ডেমো এখানে হোস্ট করা হয়েছে: https://avinal.gitlab.io/vlc-android-docs/
ডকুমেন্টেশনের প্রতিটি বিভাগে একটি লেবেলযুক্ত স্ক্রিনশট, বৈশিষ্ট্যের বিবরণ, আরও প্রযুক্তিগত অংশ থাকলে এবং বৈশিষ্ট্যটির জন্য টিপস এবং কৌশল থাকবে।
-> ডেস্কটপ থেকে এই ব্যবহারকারীর ডকুমেন্টেশন স্বাধীনভাবে বিকাশ করা আমাদের বর্তমান ডকুমেন্টেশনকে প্রভাবিত না করে বা বিকাশের সময় এটি দ্বারা প্রভাবিত না হয়ে মাত্র কয়েকটি ধাপে উভয় ডকুমেন্টেশনকে একত্রিত করতে সহায়তা করবে। আমি এই পুরো ডকুমেন্টেশনটিকে ডেভেলপ করার পর ডেস্কটপ ডকুমেন্টেশনের অ্যান্ড্রয়েড বিভাগে রাখার প্রস্তাব করছি এবং তারপর অ্যান্ড্রয়েড ডকুমেন্টেশনের জন্য VLC-এর জন্য একটি পারমালিঙ্ক তৈরি করব।
-> আরও উন্নতির মধ্যে অন্তর্ভুক্ত হতে পারে ডেস্কটপ ব্যবহারকারী ডকুমেন্টেশনের প্রারম্ভিক পৃষ্ঠাটি পুনরায় ডিজাইন করা যাতে ব্যবহারকারীরা সরাসরি তাদের প্রিয় OS বেছে নিতে পারে এবং তারপরে নির্বাচিত OS এর ডকুমেন্টেশনে পুনঃনির্দেশিত হয়। যেহেতু Windows, MacOS এবং Linux VLC ব্যবহারকারী ডকুমেন্টেশন ইতিমধ্যেই ভালভাবে ডিজাইন করা হয়েছে এবং কথোপকথন করা হয়েছে আমরা Windows/MacOS/Linux বা Android বা iOS থেকে বেছে নেওয়ার বিকল্প রাখতে পারি। এর ফলে সমস্ত পোর্টের জন্য ব্যবহার করার জন্য শুধুমাত্র একটি লিঙ্ক সহ সুন্দরভাবে আলাদা কিন্তু ইউনিফাইড ব্যবহারকারী ডকুমেন্টেশন হবে।
কেন আমার প্রস্তাবিত ব্যবহারকারী ডকুমেন্টেশন ভাল? এই প্রস্তাবিত ব্যবহারকারীর ডকুমেন্টেশনটি সাধারণ প্যাটার্নের ভিত্তিতে তৈরি করা হয়েছে যা শেষ ব্যবহারকারী সাহায্য পেতে অনুসরণ করে। ডকুমেন্টেশন সমস্ত প্রয়োজনীয় বৈশিষ্ট্যগুলিকে একত্রিত করে যেমন সরলতা, স্বচ্ছতা, চেহারা এবং অনুভূতি, প্রযুক্তিগত জ্ঞান সর্বাধিক ব্যবহারের সহজতা এবং শেষ ব্যবহারকারীর অভিজ্ঞতা। এটি সহজেই রক্ষণাবেক্ষণযোগ্য কারণ প্রতিটি পোর্টের জন্য পৃথক ব্যবহারকারীর ডকুমেন্টেশন বজায় রাখার আর প্রয়োজন নেই।
আমি কেন এই প্রকল্পের জন্য সঠিক ব্যক্তি? -> আমি এখন 2 বছর ধরে কোড লিখছি এবং প্রায়ই আমাকে নির্দিষ্ট লাইব্রেরি বা কিছু সফ্টওয়্যারের জন্য API ডকুমেন্টেশনের মাধ্যমে যেতে হবে বা এমনকি আমার নিজের কোড নথিভুক্ত করতে হবে। তাই আমি জানি যে লোকেরা ডকুমেন্টেশনে কী দেখতে চায়, তারা কোন সমস্যার সম্মুখীন হয় এবং তারা কীভাবে সাহায্য পাওয়ার জন্য যোগাযোগ করে। আমি একটি ধারাবাহিক এবং সহজে পঠনযোগ্য ডকুমেন্টেশন লিখতে একই অভিজ্ঞতা প্রয়োগ করতে সক্ষম হব।
-> আমি কোরা, স্ট্যাক ওভারফ্লো এবং অন্যান্য বিভিন্ন প্ল্যাটফর্মে সক্রিয়ভাবে প্রযুক্তিগত বিষয় লিখছি। আমি জানি কিভাবে জিনিসগুলিকে এমনভাবে ব্যাখ্যা করতে হয় যা আকর্ষণীয় এবং লোকেরা সহজেই বুঝতে পারে।
-> অ্যান্ড্রয়েডের জন্য ভিএলসি একটি শক্তিশালী এবং অত্যন্ত বিখ্যাত টুল, তবুও এর বেশিরভাগ বৈশিষ্ট্য হয় অজানা বা কোন সাহায্য উপলব্ধ নেই। আমি এখন অনেক বছর ধরে ডেস্কটপ এবং মোবাইল উভয় প্ল্যাটফর্মে VLC ব্যবহার করছি এবং আমি জানি একজন ব্যবহারকারী কী সমস্যার সম্মুখীন হতে পারে। আমার সমস্ত জ্ঞান এবং অভিজ্ঞতা একত্রিত করে আমি একটি দুর্দান্ত ডকুমেন্টেশন নিশ্চিত করতে পারি।