এই পৃষ্ঠায় Google সিজন অফ ডক্সের জন্য গৃহীত প্রযুক্তিগত লেখার প্রকল্পের বিশদ বিবরণ রয়েছে৷
প্রকল্পের সারসংক্ষেপ
- ওপেন সোর্স সংস্থা:
- ভিডিওল্যান
- কৌশলী লেখক:
- Edidiong Anny Asikpo
- প্রকল্পের নাম:
- VLC ব্যবহারকারী ডকুমেন্টেশন আধুনিকীকরণ (পুনরায় লিখুন)
- প্রকল্পের দৈর্ঘ্য:
- স্ট্যান্ডার্ড দৈর্ঘ্য (3 মাস)
প্রকল্প বর্ণনা
বিমূর্ত
একটি ব্যবহারকারী ডকুমেন্টেশন শেষ ব্যবহারকারীদের একটি পণ্য বা পরিষেবা ব্যবহার করতে সহায়তা করার জন্য ডিজাইন করা হয়েছে। ভাল ব্যবহারকারীর ডকুমেন্টেশন খুবই গুরুত্বপূর্ণ কারণ এটি ব্যবহারকারীদের একটি সফ্টওয়্যার, এর বৈশিষ্ট্য, টিপস, কৌশলগুলি কীভাবে ব্যবহার করতে হয় এবং সফ্টওয়্যার ব্যবহার করার সময় সম্মুখীন হওয়া সাধারণ সমস্যাগুলি সমাধান করতে হয় তা শিখতে একটি উপায় প্রদান করে৷ এটি সমর্থন খরচও হ্রাস করে এবং পণ্যটির কর্পোরেট পরিচয়ের অংশ: একটি ভাল ব্যবহারকারীর ডকুমেন্টেশন পণ্যের স্বাস্থ্যকরতার লক্ষণ, ডেভেলপার দল।
একটি ভাল ব্যবহারকারীর ডকুমেন্টেশন ছাড়া, একজন ব্যবহারকারী উপরের জিনিসগুলি কীভাবে কার্যকরভাবে এবং দক্ষতার সাথে করতে হয় তা জানেন না। ব্যবহারকারীর ডকুমেন্টেশনগুলি একটি পণ্যের সাফল্য নিশ্চিত করতে একটি গুরুত্বপূর্ণ ভূমিকা পালন করতে পারে কারণ দুর্দান্ত যোগাযোগ সর্বদা যে কোনও ব্যবসা বা পণ্যের কেন্দ্রস্থলে থাকে এবং থাকবে এবং একটি দুর্দান্ত ডকুমেন্টেশন কেবল সেই যোগাযোগটিকে গ্রহণ করে এবং এটিকে একটি পরিচালনাযোগ্য কাঠামোতে রাখে যা প্রত্যেকে সাফল্যের জন্য অ্যাক্সেস করতে পারে।
এই লেখার সময়, ভিএলসি ব্যবহারকারীর ডকুমেন্টেশনটি 4,634,065 বার অ্যাক্সেস করা হয়েছে এবং ভিএলসি মিডিয়া প্লেয়ারটি মূল ওয়েবসাইট থেকে প্রতি মাসে প্রায় 23 মিলিয়ন বার ডাউনলোড করা হয়, এটি দেখায় যে সারা বিশ্বে প্রচুর মানুষ ভিএলসি মিডিয়া ব্যবহার করে প্লেয়ার এবং মিডিয়া প্লেয়ার কীভাবে ব্যবহার করতে হয় তার নির্দেশনার জন্য এর ব্যবহারকারীর ডকুমেন্টেশন পড়তে চাইতে পারে। যাইহোক, ভিএলসি মিডিয়া প্লেয়ার ব্যবহারকারী ডকুমেন্টেশন বর্তমানে পুরানো এবং অসম্পূর্ণ (এটি 28 অক্টোবর 2015 তারিখে সর্বশেষ সংশোধন করা হয়েছিল) এবং VideoLAN সম্প্রদায় এই প্রকল্পটি ব্যবহার করতে চায় তার ব্যবহারকারীর ডকুমেন্টেশন উন্নত করতে যাতে শেষ ব্যবহারকারীদের একটি নির্বিঘ্ন অভিজ্ঞতা পেতে সক্ষম হয় ভিএলসি মিডিয়া প্লেয়ার ব্যবহার করে।
বর্তমান অবস্থা
বর্তমানে, ব্যবহারকারীর ডকুমেন্টেশন একটি উইকি পৃষ্ঠায় উপলব্ধ। এটি অপ্রচলিত, অসম্পূর্ণ, নেভিগেট করা বা তথ্য খুঁজে পাওয়া কঠিন, মিডিয়া প্লেয়ারের বর্তমান সংস্করণ সম্পর্কে তথ্য কভার করে না এবং শুধুমাত্র Deutsch ভাষায় অনুবাদ করা যেতে পারে যা ইংরেজি ভাষা পড়তে পারে না এমন লোকেদের জন্য একটি বড় বিপত্তি ঘটায়।
আমার প্রস্তাবিত ব্যবহারকারীর ডকুমেন্টেশন বর্তমানের চেয়ে উন্নতি কেন?
প্রস্তাবিত ব্যবহারকারী ডকুমেন্টেশন একটি শেষ ব্যবহারকারীর জন্য দক্ষতা, ধারাবাহিকতা এবং মানসিক শান্তি উন্নত এবং নিশ্চিত করার জন্য গঠন করা হবে। এতে লিখিত নির্দেশিকা এবং এর সাথে সম্পর্কিত ছবি থাকবে, ভিএলসি মিডিয়া প্লেয়ারের প্রতিটি বৈশিষ্ট্য কীভাবে ব্যবহার করবেন তার নির্দেশাবলী এবং ব্যাখ্যা অন্তর্ভুক্ত থাকবে, আপ টু ডেট, নেভিগেট করা সহজ, বোধগম্য এবং কমপক্ষে পাঁচটি প্রধান ভাষায় অনুবাদযোগ্য।
পরামর্শদাতা: জিন-ব্যাপটিস্ট, অ্যালেক্স, সাইমন
বিশ্লেষণ
জিন-ব্যাপটিস্ট এবং আমি নতুন পরিবেশ সম্পর্কে একটি কথোপকথন করেছি যেখানে বর্তমান ব্যবহারকারীর ডকুমেন্টেশন উন্নতির জন্য স্থানান্তরিত হবে এবং তিনি দুটি লিঙ্ক ভাগ করেছেন যেগুলি স্ফিঙ্কসের সাথে লেখা সোর্স ফাইলের একটি গিটল্যাব সংগ্রহস্থল এবং Read the Docs এ হোস্ট করা প্রধান ডকুমেন্টেশন দেখায়। তিনি বলেন, তারা আশা করছে নতুন ডকুমেন্টেশন এর মতই হবে। এটি কীভাবে কাজ করে তা আরও ভালভাবে বোঝার জন্য আমি এই সরঞ্জামগুলি সম্পর্কে অনেক গবেষণা করেছি।
স্ফিংক্স
Sphinx সফ্টওয়্যার ডকুমেন্টেশনের জন্য একটি শক্তিশালী এবং পরিপক্ক সমাধান। এটিতে অনেকগুলি বৈশিষ্ট্য রয়েছে যা লেখকরা আশা করেন, যেমন একক উত্স প্রকাশ, সামগ্রীর পুনঃব্যবহার অন্তর্ভুক্ত, শর্তসাপেক্ষে অন্তর্ভুক্ত বিষয়বস্তুর প্রকার এবং ট্যাগের উপর ভিত্তি করে, একাধিক পরিপক্ক এইচটিএমএল থিম যা মোবাইল এবং ডেস্কটপে একটি দুর্দান্ত ব্যবহারকারীর অভিজ্ঞতা প্রদান করে, পৃষ্ঠা, নথি জুড়ে উল্লেখ , এবং প্রকল্প সূচক এবং শব্দকোষ সমর্থন এবং আন্তর্জাতিকীকরণ সমর্থন. এটি তার মার্কআপ ভাষা হিসাবে restructuredText ব্যবহার করে এবং এর অনেক শক্তি restructuredText এর ক্ষমতা এবং সরলতা এবং ডকুমেন্টেশন অনুবাদ করার ক্ষমতা থেকে আসে।
ডক্স পড়ুন
দস্তাবেজ পড়ুন আপনার জন্য আপনার নথির স্বয়ংক্রিয় বিল্ডিং, সংস্করণ এবং হোস্টিং দ্বারা সফ্টওয়্যার ডকুমেন্টেশনকে সহজ করে। এটি কখনই সিঙ্কের বাইরে যায় না; অর্থাৎ, আপনি যখনই আপনার পছন্দের সংস্করণ নিয়ন্ত্রণ ব্যবস্থায় কোড পুশ করেন, সেটি গিট, মার্কিউরিয়াল, বাজার বা সাবভারশনই হোক না কেন, ডক্স পড়ুন স্বয়ংক্রিয়ভাবে আপনার ডক্স তৈরি করবে যাতে আপনার কোড এবং ডকুমেন্টেশন সবসময় আপ-টু-ডেট থাকে। এর একাধিক সংস্করণ রয়েছে; ডক্স পড়ুন আপনার ডক্সের একাধিক সংস্করণ হোস্ট এবং তৈরি করতে পারে তাই আপনার ডক্সের 1.0 সংস্করণ এবং আপনার ডক্সের 2.0 সংস্করণ থাকা আপনার সংস্করণ নিয়ন্ত্রণ সিস্টেমে একটি পৃথক শাখা বা ট্যাগ থাকার মতোই সহজ৷ ডক্স পড়ুন বিনামূল্যে এবং ওপেন সোর্স এবং প্রায় প্রতিটি মানুষের এবং কম্পিউটার ভাষায় প্রায় 100,000টি বড় এবং ছোট ওপেন সোর্স প্রকল্পের জন্য ডকুমেন্টেশন হোস্ট করে৷
রায়
Sphinx একটি অবিশ্বাস্যভাবে শক্তিশালী টুল এবং Sphinx ডকুমেন্টেশনের জন্য হোস্টিং প্রদান করতে শীর্ষে ডক্স বিল্ডগুলি পড়ুন যা আপনার নথিগুলিকে বিভিন্ন সংস্করণে আপ টু ডেট রাখে৷ একত্রে, তারা একটি দুর্দান্ত সরঞ্জাম যা বিকাশকারী এবং প্রযুক্তিগত লেখকরা ব্যবহারকারী ডকুমেন্টেশন তৈরি করতে ব্যবহার করতে পারে যা শেষ ব্যবহারকারীদের জন্য সেরা হবে।
স্ফিংক্স একাধিক ভাষায় ডকুমেন্টেশন অনুবাদ করার জন্য সমর্থন অন্তর্ভুক্ত করে। এটি সংস্করণ নিয়ন্ত্রণ সমর্থন করে যা ডকুমেন্টেশন পরিচালনা করতে ব্যবহৃত হবে। বর্তমান উইকির বিপরীতে যেখানে যে কেউ সম্পাদনা করতে পারে এবং সঠিক তথ্য যোগ করতে পারে না, এই সংস্করণ নিয়ন্ত্রণ ব্যবস্থা নিশ্চিত করবে যে সমস্ত পরিবর্তনগুলি মূল সংগ্রহস্থলে একত্রিত হওয়ার আগে প্রথমে পর্যালোচনা করা হবে। সংস্করণ নিয়ন্ত্রণ ডকুমেন্টেশনকে প্রকল্পে ওপেন সোর্স অবদান বাড়াতেও সাহায্য করবে কারণ মানুষ সমস্যা তৈরি করতে পারে, টানার অনুরোধগুলি খুলতে পারে, ইত্যাদি ASP.NET, Kernel, Julia, Jupyter, PHPMyAdmin, ডক্স লিখুন, ইত্যাদি এবং এটি নতুন VLC ব্যবহারকারী ডকুমেন্টেশনের জন্য ব্যবহার করার জন্য একটি দুর্দান্ত সরঞ্জাম।
আমি কেবল এই সরঞ্জামগুলি সম্পর্কে পড়িনি, আমি একটি মৌলিক নমুনাও তৈরি করেছি। এই লিঙ্কটি হল: https://gitlab.com/Didicodes/demo-vlc-user-documentation আমার গিটল্যাব রিপোজিটরিতে যখন readthedocs-এ হোস্ট করা সংস্করণটি এখানে পাওয়া যাবে: [https://vlc-user-documentation-demo। readthedocs.io/en/latest/](https://vlc-user-documentation-demo.readthedocs.io/en/latest/.
প্রস্তাবিত ডকুমেন্টেশনের কাঠামো
আমি ভিএলসি ব্যবহারকারী ডকুমেন্টেশনের জন্য একটি কাঠামো তৈরি করেছি যা এখানে পাওয়া যাবে; https://docs.google.com/document/d/1Sy2V2IADoCyfnGBK70v8mkjiWK2tH-oWdUlDxAfQAYA/edit?usp=sharing এই নতুন কাঠামোর বাস্তবায়ন শুরু হওয়ার আগে এটিকে পরামর্শদাতাদের দ্বারা অনুমোদিত হতে হবে। এর মানে হল যে মেন্টরদের দ্বারা পর্যালোচনা করার পরে কাঠামোটি পরিবর্তন হতে পারে।
প্রকল্পের লক্ষ্য
- ডকুমেন্টেশন পুনর্গঠন.
- VLC এর আধুনিক সংস্করণের সাথে মানানসই ডকুমেন্টেশন আপডেট করুন।
- Sphinx এবং ReadtheDocs ব্যবহার করে ব্যবহারকারীর ডকুমেন্টেশন গিটল্যাবে স্থানান্তর করুন।
- অপ্রচলিত ছবি এবং তথ্য সরান.
- বুঝতে সহজ করতে ব্যবহারকারীর ডকুমেন্টেশন পুনরায় লিখুন।
- Sphinx আন্তর্জাতিকীকরণ ব্যবহার করে অনুবাদের জন্য এটি সেট আপ করুন।
- ডকুমেন্টেশন সম্প্রদায়কে চালিত করুন যাতে ব্যবহারকারীরা ডকুমেন্টেশন পড়ার সময় যে কোনো সমস্যার সম্মুখীন হলে রিপোর্ট করতে বা সমাধান করতে পারে।
কেন এই প্রকল্প?
আমার সর্বদা একটি দৃঢ় বিশ্বাস ছিল যে কোড লেখা, সমস্যা সমাধান করা এবং সফ্টওয়্যার তৈরি করা তার পূর্ণ সম্ভাবনায় পৌঁছে যায় যখন আপনার লেখার মাধ্যমে অন্যদেরকে এটি সম্পর্কে আলোকিত করার ক্ষমতা থাকে। ব্যক্তিগতভাবে, মাল্টিমিডিয়ার জন্য বিনামূল্যের সফ্টওয়্যার সমাধান তৈরিতে VideoLAN সম্প্রদায়ের প্রচেষ্টায় আমি সবসময় মুগ্ধ হয়েছি। ছোটবেলায় বেড়ে ওঠা, ভিএলসি মিডিয়া প্লেয়ার ছিল সবসময়ই এমন একটি সফটওয়্যার যা আমি গান শোনার সময় বা সিনেমা দেখার সময় ব্যবহার করি কারণ এটি খুব জোরে ছিল এবং এতে অনেকগুলি বৈশিষ্ট্য রয়েছে। আমার শৈশবকে অসাধারণ করে তোলার জন্য অবদান রাখা সম্প্রদায়ের সাথে কাজ করা একটি সম্মানের বিষয় হবে।
আমি কেন এই প্রকল্পের জন্য সঠিক ব্যক্তি
আমি বিশ্বাস করি আমি এই প্রকল্পের জন্য সঠিক ব্যক্তি কারণ:
- প্রতিষ্ঠানের ডকুমেন্টেশন উন্নত করার ক্ষেত্রে আমার অতীত অভিজ্ঞতা আছে এবং আমি যেকোন সংস্করণ নিয়ন্ত্রণ ব্যবস্থা ব্যবহার করতে পারি, তাই গীতাবে কমান্ড পরিচালনা করা কোনো সমস্যা হবে না। তদুপরি, যা আমাকে চালিত করে এমন প্রকল্পগুলিতে কাজ করে যা মানুষের জন্য মূল্য তৈরি করে।
- আমি বিশ্বাস করি যে আপনি যদি কাউকে সবচেয়ে কার্যকর উপায়ে কিছু করতে চান তবে আপনি এটি নথিভুক্ত করুন। আপনার প্রক্রিয়াগুলি নথিভুক্ত করার মাধ্যমে, আপনি জড়িত যে কারও জন্য দক্ষতা, ধারাবাহিকতা এবং মানসিক শান্তি নিশ্চিত করেন।
- আমি VLC ব্যবহারকারীদের চাহিদা জানি কারণ আমি তাদের একজন। এটি এমনভাবে ডকুমেন্টেশন লিখতে সক্ষম করবে যাতে সারা বিশ্বের প্রতিটি ব্যবহারকারী প্রথম নজরে বুঝতে পারে।