এই পৃষ্ঠায় Google সিজন অফ ডক্সের জন্য গৃহীত প্রযুক্তিগত লেখার প্রকল্পের বিশদ বিবরণ রয়েছে৷
প্রকল্পের সারসংক্ষেপ
- ওপেন সোর্স সংস্থা:
- ScummVM
- কৌশলী লেখক:
- ক্যাডি
- প্রকল্পের নাম:
- একটি ডকুমেন্টেশন পোর্টাল চালু করুন
- প্রকল্পের দৈর্ঘ্য:
- স্ট্যান্ডার্ড দৈর্ঘ্য (3 মাস)
প্রকল্প বর্ণনা
উদ্দেশ্য:
- উচ্চ-মানের, সংস্করণযুক্ত শেষ ব্যবহারকারীর ডকুমেন্টেশন তৈরি করতে আলাদা উৎস থেকে প্রচুর পরিমাণে তথ্য একত্রিত করে এবং স্বচ্ছতা, ধারাবাহিকতা এবং সম্পূর্ণতার জন্য তথ্য পুনঃলিখন করা।
- কারিগরি জ্ঞানসম্পন্ন ব্যবহারকারীদের পৃষ্ঠপোষকতা না করে নথিপত্রটি নতুনদের জন্য বোঝা সহজ হওয়া উচিত।
- একটি স্ট্যাটিক-সাইট জেনারেটর ব্যবহার করে একটি ডকুমেন্টেশন পোর্টাল তৈরি করতে।
- ভবিষ্যতের ওপেন সোর্স অবদানকারীদের জন্য টেমপ্লেট এবং বিস্তারিত কীভাবে নির্দেশাবলী তৈরি করে ভবিষ্যত-প্রমাণ শেষ ব্যবহারকারীর ডকুমেন্টেশন।
বর্তমান অবস্থা:
- উপলব্ধ ScummVM ডকুমেন্টেশন একাধিক উত্স জুড়ে ছড়িয়ে আছে।
- তথ্য খুঁজে পাওয়া কঠিন এবং প্রায়ই নকল করা হয়; অস্পষ্ট পাতায় হারিয়ে যাওয়া সহজ।
- কোন তথ্য বর্তমান, এবং কোনটি পুরানো তা জানা কঠিন।
- কিছু তথ্য অনুপস্থিত বা অসম্পূর্ণ।
সমস্যা সমাধান:
প্রস্তাবিত ডকুমেন্টেশন গঠন:
ল্যান্ডিং পৃষ্ঠা |-- শুরু করা | -- Quick start guide |-- Installing ScummVM | |-- Nintendo 3DS | |-- AmigaOS | |-- Android | |-- (every) | |-- (common) | |-- (supported) | -- (প্ল্যাটফর্ম) |-- ScummVM ব্যবহার করে | |-- লঞ্চার | |-- গ্লোবাল সেটিংস | |-- গেম সেটিংস | -- Keyboard shortcuts |-- Advanced options | |-- Cloud and LAN | |-- Control Mapping | |-- Configuration | |-- Command line options | |-- Graphics | -- সঙ্গীত এবং শব্দ |- সাহায্য | |--- প্রায়শই জিজ্ঞাসিত প্রশ্ন | |-- পরিচিতি | |--- পরিচিত সমস্যা | -- Reporting a bug |-- Game Notes -- রিলিজ নোট
- শুরু হচ্ছে:
নতুন ব্যবহারকারীরা প্রায়শই যত তাড়াতাড়ি সম্ভব যেতে একটি দ্রুত সূচনা নির্দেশিকা সন্ধান করে। কিছু প্ল্যাটফর্মে ScummVM এর ইনস্টলেশন জটিল হতে পারে, এটি একটি কম্পিউটারে ইনস্টল করা নয়।
কুইকস্টার্ট গাইড নিম্নলিখিত কভার করা উচিত:
- উইন্ডোজ, ম্যাক এবং লিনাক্সে কীভাবে ScummVM ইনস্টল করবেন।
কিভাবে একটি গেম লোড, যোগ এবং লঞ্চ করবেন।
ScummVM ইনস্টল করা হচ্ছে:
যে ক্ষেত্রে ইনস্টলটি স্বজ্ঞাত নয়, বা যেখানে ব্যবহারকারীর একটি শক্তিশালী প্রযুক্তিগত ভিত্তি নাও থাকতে পারে, ব্যবহারকারীর যেকোন সমর্থিত প্ল্যাটফর্মে ScummVM ইনস্টল করার জন্য একটি বিস্তৃত নির্দেশিকা প্রয়োজন।
প্রতিটি ব্যাপক ইনস্টলেশন পৃষ্ঠা নিম্নলিখিত কভার করা উচিত:
- যেকোন সিস্টেমের প্রয়োজনীয়তা/পূর্বশর্ত।
- কিভাবে ScummVM এর উপযুক্ত সংস্করণ ডাউনলোড করবেন।
- কিভাবে ScummVM ইনস্টল করবেন।
- কীভাবে বেছে নেওয়া প্ল্যাটফর্মে গেমগুলি লোড করবেন, বিশেষত যেখানে এটি সেই প্ল্যাটফর্ম নয় যেখানে গেমটি ডিজাইন করা হয়েছিল।
কিভাবে ScummVM চালু করবেন, একটি গেম যোগ করবেন এবং একটি গেম চালু করবেন।
ScummVM ব্যবহার করে:
ব্যবহারকারীদের রেফারেন্স ডকুমেন্ট প্রয়োজন যা ব্যাখ্যা করে কিভাবে ScummVM ব্যবহার করতে হয়।
রেফারেন্স নথি নিম্নলিখিত আবরণ করা উচিত:
- লঞ্চার ইন্টারফেস; প্রতিটি উইন্ডো এবং ট্যাব দেখতে কেমন এবং তারা কিভাবে কাজ করে।
- উপলব্ধ সেটিংসের একটি ব্যাখ্যা, উভয় গ্লোবাল এবং গেম-নির্দিষ্ট।
কীবোর্ড শর্টকাট/হটকি।
উন্নত বিকল্প:
উন্নত ব্যবহারকারীদের তাদের গেমগুলি কীভাবে চলে তা টুইক করার জন্য তাদের কাছে উপলব্ধ বিকল্পগুলি সম্পর্কে অতিরিক্ত, আরও প্রযুক্তিগত তথ্য প্রয়োজন।
- গেমের নোট:
কোনো গেম-নির্দিষ্ট তথ্য একজন ব্যবহারকারীর জানা প্রয়োজন; সহ কিন্তু সীমিত নয়: - ইনস্টল করার ছক - যেকোন অতিরিক্ত ফাইলের প্রয়োজন - অস্বাভাবিক বা ভিন্ন নিয়ন্ত্রণ
- পরিচিত সমস্যা:
এই বিভাগে প্রকাশের জন্য নির্দিষ্ট কোনো পরিচিত বাগ থাকা উচিত।
- অব্যাহতি পত্র:
যদিও আমাদের ডকুমেন্টেশন সংস্করণ করা হবে, একটি রিলিজ নোট বিভাগ থাকা সর্বশেষ রিলিজে পরিবর্তনের সারসংক্ষেপ প্রদান করতে সহায়ক হতে পারে। এর মধ্যে এমন কিছু ক্ষেত্র অন্তর্ভুক্ত থাকতে পারে যা বর্তমানে এই ডকুমেন্টেশনের সুযোগের বাইরে, যেমন নতুন সমর্থিত গেম বা নতুন ইঞ্জিন সম্পর্কে তথ্য।
আক্রমণের পরিকল্পনা:
আমি ScummVM পৃষ্ঠাগুলি ইনস্টল করার জন্য একটি টেমপ্লেট তৈরি করে শুরু করার প্রস্তাব করছি, কারণ পোর্ট রক্ষণাবেক্ষণকারী/ডেভেলপারদের (বিশেষ করে যেখানে এই তথ্যটি খুব কম বা বিদ্যমান নেই) থেকে আমার প্রয়োজনীয় তথ্য পাওয়ার জন্য এটিই হবে সবচেয়ে সহজ উপায়। বিদ্যমান ডকুমেন্টেশন থেকে আমার কাছে ইতিমধ্যেই আছে এমন যেকোন তথ্য আমি প্রাক-ভর্তি করব, যা পরে সম্পূর্ণতা, নির্ভুলতা এবং মুদ্রার জন্য পরীক্ষা করা যেতে পারে বা প্রয়োজনে যোগ করা যেতে পারে।
পরবর্তী আমি বিদ্যমান ডকুমেন্টেশন চিরুনি করব; README, উইকি এবং ওয়েবসাইট। আমি যেতে যেতে, আমি পুনরায় লিখব এবং প্রয়োজন অনুসারে প্রতিটি বিভাগে যোগ করব এবং সমস্ত তথ্য নতুন পোর্টালে টানব। পোর্টালটি একবার লাইভ হয়ে গেলে সেখানে কোনো দ্বিগুণ, বৈপরীত্য, বা অন্যান্য অসঙ্গতি নেই তা নিশ্চিত করতে আমি কোন তথ্য কোথা থেকে আনা হয়েছে তাও নোট করব।
সর্বোপরি, আমি যেকোনও অনুপস্থিত তথ্যের উৎসের জন্য পরামর্শদাতা(গণ), বিকাশকারী, বন্দর রক্ষণাবেক্ষণকারী এবং অন্য যেকোন বিষয় বিশেষজ্ঞদের সাথে যোগাযোগ করব, সেইসাথে প্রতিটি পৃষ্ঠা যতটা সম্ভব আপ-টু-ডেট এবং ব্যাপকভাবে নিশ্চিত করব।
সহযোগিতার চেতনায় এবং পরামর্শদাতাদের কাছ থেকে অনুমোদন সাপেক্ষে, আমি লিখার প্রক্রিয়া জুড়ে ScummVM সম্প্রদায়ের কাছে কাজের-প্রগতিশীল পোর্টালটি অ্যাক্সেসযোগ্য রাখতে চাই, যাতে রিয়েল-টাইম প্রতিক্রিয়া পাওয়া যায় এবং নিশ্চিত করা যায় যে কোনও কিছুই মিস না হয়। রাস্তা.
আমি একটি স্টাইল গাইড ব্যবহার করার পরামর্শ দিই, যেমন Google ডেভেলপার ডকুমেন্টেশন স্টাইল গাইড, কাজের এই অংশের জন্য এবং সমস্ত ডকুমেন্টেশন এগিয়ে যাওয়ার জন্য ধারাবাহিকতা নিশ্চিত করতে।
যেখানেই সম্ভব, আমি বোঝাপড়া বাড়ানোর জন্য স্ক্রিনশট, জিআইএফ এবং অন্যান্য ভিজ্যুয়াল সাহায্য ব্যবহার করব।
প্রস্তাবিত সময়রেখা:
কমিউনিটি বন্ধন 17 আগস্ট - 13 সেপ্টেম্বর, 2020
প্রজেক্টের দৃষ্টিভঙ্গি ঠিক করতে এবং নথির কাঠামো এবং বিষয়বস্তুর মতো বিশদ বিবরণ চূড়ান্ত করতে পরামর্শদাতা(দের) এবং বৃহত্তর ScummVM সম্প্রদায়ের সাথে কথা বলে সময় কাটাতে থাকুন।
সপ্তাহ 1 সেপ্টেম্বর 14 - সেপ্টেম্বর 20
- প্ল্যাটফর্ম-নির্দিষ্ট ইনস্টলেশন পৃষ্ঠাগুলির জন্য একটি টেমপ্লেট তৈরি করুন।
- যেকোনো বিদ্যমান তথ্য দিয়ে টেমপ্লেটগুলিকে পূর্বে পূরণ করুন এবং আরও তথ্যের জন্য উপযুক্ত পোর্ট রক্ষণাবেক্ষণকারী/ডেভেলপারদের কাছে বিতরণ করুন।
সপ্তাহ 2 21 সেপ্টেম্বর - 27 সেপ্টেম্বর
- নতুন ডকুমেন্টেশন পোর্টাল সেট আপ করুন.
3 সেপ্টেম্বর 28 - অক্টোবর 4 সপ্তাহ
ScummVM ব্যবহার করা: - ইন্টারফেস - গ্লোবাল সেটিংস ScummVM ইনস্টল করা হচ্ছে: - সম্পূর্ণ টেমপ্লেট হিসাবে প্ল্যাটফর্ম-নির্দিষ্ট ইনস্টলেশন গাইড আমাকে ফেরত দেওয়া হয়।
সপ্তাহ 4 অক্টোবর 5 - অক্টোবর 11
ScummVM ব্যবহার করা: - গেম সেটিংস - কীবোর্ড শর্টকাট ScummVM ইনস্টল করা: - সম্পূর্ণ টেমপ্লেট হিসাবে প্ল্যাটফর্ম-নির্দিষ্ট ইনস্টলেশন গাইড আমাকে ফেরত দেওয়া হয়
সপ্তাহ 5 অক্টোবর 12 - অক্টোবর 18
উন্নত বিকল্পগুলি: - ক্লাউড এবং LAN - কন্ট্রোল ম্যাপিং ইনস্টলিং ScummVM: - প্ল্যাটফর্ম-নির্দিষ্ট ইনস্টলেশন গাইড সম্পূর্ণ টেমপ্লেট হিসাবে আমাকে ফেরত দেওয়া হয়
সপ্তাহ 6 অক্টোবর 19 - অক্টোবর 25
উন্নত বিকল্পগুলি: - কনফিগারেশন - কমান্ড লাইন বিকল্পগুলি ScummVM ইনস্টল করা হচ্ছে: - সম্পূর্ণ টেমপ্লেট হিসাবে প্ল্যাটফর্ম-নির্দিষ্ট ইনস্টলেশন গাইডগুলি আমাকে ফেরত দেওয়া হয়
সপ্তাহ 7 অক্টোবর 26 - নভেম্বর 1
উন্নত বিকল্পগুলি: - গ্রাফিক্স - অডিও ইনস্টল করা ScummVM: - সম্পূর্ণ টেমপ্লেট হিসাবে প্ল্যাটফর্ম-নির্দিষ্ট ইনস্টলেশন গাইডগুলি আমাকে ফেরত দেওয়া হয়
সপ্তাহ 8 নভেম্বর 2 - নভেম্বর 8
সাহায্য: - FAQ - পরিচিতি - পরিচিত সমস্যাগুলি৷
ScummVM ইনস্টল করা: - সম্পূর্ণ টেমপ্লেট হিসাবে প্ল্যাটফর্ম-নির্দিষ্ট ইনস্টলেশন গাইড আমাকে ফেরত দেওয়া হয়
সপ্তাহ 9 নভেম্বর 9 - নভেম্বর 15
সাহায্য: - একটি বাগ রিপোর্ট করা - গেম নোট - রিলিজ নোট
ScummVM ইনস্টল করা: - এখনও সম্পূর্ণ হয়নি এমন কোনো প্ল্যাটফর্ম গাইড চূড়ান্ত করুন।
সপ্তাহ 10 নভেম্বর 16 - নভেম্বর 22
- চূড়ান্ত সম্পাদনা, প্রুফরিডিং, এবং সাইডবার নেভিগেশন, থিম/সিএসএস টুইক ইত্যাদির মতো পোর্টাল সম্পর্কিত যেকোনো সিদ্ধান্ত চূড়ান্ত করা।
- সমস্ত লিঙ্ক প্রত্যাশিত হিসাবে কাজ নিশ্চিত করুন.
- সঠিকভাবে ছবি/gif প্রদর্শন পরীক্ষা করুন.
সপ্তাহ 11 নভেম্বর 23 - নভেম্বর 30
- কোনো অসামান্য আইটেম চূড়ান্ত করুন এবং আনুষ্ঠানিকভাবে পোর্টাল চালু করুন!
- পোর্টালটি চালু হয়ে গেলে, পরামর্শদাতাদের সাথে পরামর্শ করে অন্যান্য উত্স থেকে অপ্রয়োজনীয় তথ্য সরিয়ে ফেলুন।