এই পৃষ্ঠায় Google সিজন অফ ডক্সের জন্য গৃহীত প্রযুক্তিগত লেখার প্রকল্পের বিশদ বিবরণ রয়েছে৷
প্রকল্পের সারসংক্ষেপ
- ওপেন সোর্স সংস্থা:
- SciPy
- কৌশলী লেখক:
- mkg33
- প্রকল্পের নাম:
- ব্যবহারকারী-ভিত্তিক ডকুমেন্টেশন এবং পুঙ্খানুপুঙ্খ পুনর্গঠন
- প্রকল্পের দৈর্ঘ্য:
- স্ট্যান্ডার্ড দৈর্ঘ্য (3 মাস)
প্রকল্প বর্ণনা
প্রেরণা:
আমি বিদ্যমান ডকুমেন্টেশনের রিফ্যাক্টরিংয়ের উপর কাজ করতে চাই, যাতে এটি বিভিন্ন প্রয়োজনের ব্যবহারকারীদের দ্বারা সহজে অ্যাক্সেসযোগ্য হয়। এটি বলার অপেক্ষা রাখে না যে একজন গবেষক সম্ভবত উন্নত এবং সূক্ষ্ম বৈশিষ্ট্যগুলিতে আগ্রহী, যেখানে পূর্বে দক্ষতা ছাড়াই একজন ব্যবহারকারী ধাপে ধাপে নির্দেশিকা এবং ডায়াগ্রামের প্রশংসা করেন।
আমি ব্যক্তিগত এবং পেশাগত কারণে এই প্রকল্পটি অনুসরণ করতে আগ্রহী: প্রথমত, আমি SciPy-এ উল্লেখযোগ্যভাবে অবদান রাখতে চাই কারণ আমার নিজের গবেষণা এটি থেকে ব্যাপকভাবে উপকৃত হয়েছে এবং দ্বিতীয়ত, আমি অন্যান্য ক্ষেত্রে প্রায়ই অপর্যাপ্ত (বা অভাব) ডকুমেন্টেশনের সম্মুখীন হই। সফ্টওয়্যার এবং সর্বদা আশ্চর্য হয় যে ব্যবহারকারীরা কত দ্রুত (যদি এটি সব!) কোডটি কীভাবে ব্যবহার করতে হয় তা শিখতে পারে যদি তাদের একটি পুঙ্খানুপুঙ্খ গাইড সরবরাহ করা হয়।
লক্ষ্য:
আমি বিদ্যমান SciPy ডকুমেন্টেশনকে বিষয়বস্তু- এবং গ্রাফিক-ভিত্তিক উভয়ই উন্নত করার লক্ষ্য রাখি। এই সমস্যাটির প্রতি আমার দৃষ্টিভঙ্গির সবচেয়ে গুরুত্বপূর্ণ বৈশিষ্ট্য হল ব্যবহারকারী সমীক্ষার স্থাপনা এবং বিশ্লেষণ, অর্থাৎ, অনলাইনে পরিচালিত একটি সংক্ষিপ্ত সমীক্ষা যা বিভিন্ন ব্যবহারকারীকে ডকুমেন্টেশনের বিষয়ে তাদের চাহিদাগুলিকে ভয়েস করতে সক্ষম করে। আমি দৃঢ়ভাবে বিশ্বাস করি যে তাদের মতামত অনুপ্রেরণার উৎস হওয়া উচিত (আর কীভাবে আমরা আরও ব্যবহারকারী-বান্ধব ডকুমেন্টেশন তৈরি করতে পারি?)।
প্রকল্পের বাস্তবায়নের ক্ষেত্রে, প্রথম পর্যায়ে ব্যবহারকারী সমীক্ষার নকশা এবং বিশ্লেষণের পাশাপাশি বর্তমান ডকুমেন্টেশনে আমি লক্ষ্য করেছি এমন বেশ কয়েকটি স্টাইলিস্টিক সমস্যা মোকাবেলা করা জড়িত। উদাহরণস্বরূপ, সামঞ্জস্যের অভাব (উদাহরণ: দ্বি-মাত্রিক অ্যারেগুলির পাশাপাশি ঘটছে 2-মাত্রিক অ্যারে), জটিল বাক্য যা পুনরায় লিখতে হবে, বা নির্দিষ্ট উপপৃষ্ঠাগুলিতে বর্ণানুক্রমের অভাব। দ্বিতীয় পর্বে প্রাসঙ্গিক বিষয়গুলির হাইপারলিঙ্ক সমন্বিত গ্রাফিকাল গাইডের প্রবর্তনের উপর ফোকাস করা হবে (জরিপের ফলাফল এবং অন্যান্য সম্প্রদায়ের অনুরোধের উপর ভিত্তি করে)। দীর্ঘমেয়াদে, আমি বিভিন্ন ধরণের ব্যবহারকারীদের জন্য তৈরি একটি সন্তোষজনক ডকুমেন্টেশন অর্জন করতে চাই। তাছাড়া, আমি টিউটোরিয়ালগুলিকে ভাষাগত এবং কাঠামোগতভাবে আরও সামঞ্জস্যপূর্ণ করার চেষ্টা করব। শেষ কিন্তু অন্তত নয়, আমি নতুন টিউটোরিয়াল লিখতে চাই (বর্তমান সম্প্রদায়ের চাহিদার উপর ভিত্তি করে)।
ব্যবহারকারী সমীক্ষা:
ব্যবহারকারী সমীক্ষার বিষয়ে, আমি বিভিন্ন কারণে Google ফর্মগুলি ব্যবহার করার প্রস্তাব করছি৷ প্রথমত, Google Forms বিনামূল্যে এবং সীমাহীন কার্যকারিতা অফার করে (উত্তরদাতাদের সংখ্যা, প্রশ্ন ইত্যাদির পরিপ্রেক্ষিতে), এটির একটি আকর্ষণীয় ভিজ্যুয়াল ফর্ম রয়েছে, সবচেয়ে দরকারী জরিপ বিকল্পগুলি (উদাহরণস্বরূপ, কাস্টমাইজযোগ্য লিনিয়ার স্কেল, চেকবক্স, এবং একাধিক পছন্দ), এবং, সবচেয়ে গুরুত্বপূর্ণভাবে, পরিসংখ্যানগত বিশ্লেষণের উদ্দেশ্যে ফলাফলগুলি সহজেই রপ্তানি করা যেতে পারে। অনলাইন গবেষণার উপর ভিত্তি করে, এটি প্রদর্শিত হয় যে Google Forms, অন্তত আপাতত, সমীক্ষা পরিচালনার জন্য সেরা বিনামূল্যের টুল। একটি কম গুরুতর নোটে, Google-চালিত উদ্যোগে একটি Google পণ্য ব্যবহার করা একটি চমৎকার অঙ্গভঙ্গি হবে।
আমি নমুনা প্রশ্ন সহ একটি প্রাথমিক সমীক্ষা তৈরি করেছি (এটি https://docs.google.com/forms/d/e/1FAIpQLSeBAO0UFKDZyKpg2XzRslsLJVHU61ugjc18-2PVEabTQg2_6g/viewform এ অ্যাক্সেস করা যেতে পারে)। চূড়ান্ত সংস্করণে একটি যুক্তিসঙ্গত সংখ্যক প্রশ্ন দশ থেকে পনেরটির মধ্যে হওয়া উচিত। সুনির্দিষ্ট ফলাফল পাওয়ার জন্য, আমি পরামর্শ দিই যে আমরা প্রধানত একাধিক পছন্দের প্রশ্ন, একটি রৈখিক স্কেল এবং কয়েকটি চেকবক্স ব্যবহার করি। রৈখিক স্কেল একটি সম্পূর্ণ বর্ণালী সাদৃশ্য করা উচিত নয়, যদিও (এটি শুধুমাত্র বিভ্রান্তি সৃষ্টি করে এবং ফলাফলগুলি উচ্চ বিচ্ছুরণে ভুগতে পারে)। সর্বাধিক দুটি উন্মুক্ত প্রশ্ন থাকা উচিত, অন্যথায় ফলাফলগুলি অত্যন্ত বিচ্ছুরিত হবে এবং মোটেও সহায়ক হবে না। আমি মনে করি যে পরিসংখ্যানগত সফ্টওয়্যার দিয়ে ডেটা সহজেই রপ্তানি এবং স্বয়ংক্রিয়ভাবে বিশ্লেষণ করা যায় বলে খুব বেশি সংখ্যক প্রতিক্রিয়া সমস্যাযুক্ত হবে না। অনুমান করা হয় যে উত্তরের সংখ্যা, প্রকৃতপক্ষে, খুব বেশি, উন্মুক্ত প্রশ্নগুলির বিশ্লেষণ একটু সময়সাপেক্ষ হতে পারে তবে আমি অনুমান করি যে এটি অপ্রতিরোধ্য হবে না। সর্বোপরি, একজন গড় ব্যবহারকারী ডকুমেন্টেশনের অবস্থা সম্পর্কে একটি প্রবন্ধ লিখতে পারে না। সবচেয়ে খারাপ পরিস্থিতিতে, কিছু উত্তর কেবল ভবিষ্যতের বিশ্লেষণের জন্য সংরক্ষণ করা যেতে পারে।
গ্রাফিকাল গাইড:
গ্রাফিকাল গাইডগুলির আমার দৃষ্টিভঙ্গি (নেভিগেশনাল সরঞ্জাম হিসাবে পরিবেশন করার উদ্দেশ্যে) একটি জনপ্রিয় ভিত্তির উপর ভিত্তি করে যে (বেশিরভাগ) মানুষ বিশুদ্ধভাবে পাঠ্য-ভিত্তিক তথ্যের চেয়ে সহজবোধ্য ভিজ্যুয়াল কাঠামো প্রক্রিয়াকরণে ভাল। অধিকন্তু, আগ্রহের অনুরূপ বিষয়গুলির সাথে সংযোগকারী লাইনগুলির সাথে একটি বিষয়ভিত্তিক-ভিত্তিক চিত্র নিঃসন্দেহে, কম অভিজ্ঞ ব্যবহারকারীদের জন্য একটি অত্যন্ত মূল্যবান সম্পদ (এবং কেবল নয়)।
বাস্তবায়নের বিশদ বিবরণ হিসাবে, আমি TikZ প্যাকেজ ব্যবহার করার প্রস্তাব করছি। প্রথম এবং সর্বাগ্রে, এটি একটি শক্তিশালী হাতিয়ার এবং শীঘ্রই অবমূল্যায়িত হওয়ার ঝুঁকি আছে বলে মনে হয় না৷ এটি উচ্চ-মানের আউটপুটও অফার করে, একটি সত্যিই শক্ত ডকুমেন্টেশন রয়েছে এবং এটি TeX StackExchange এবং অন্যান্য মূলধারার ফোরামে একটি ঘন ঘন বিষয়। সবচেয়ে গুরুত্বপূর্ণ, এইচটিএমএল ডকুমেন্টেশনের সাথে একটি TikZ ফাইলের (আরো সঠিকভাবে, এতে অসংখ্য হাইপারলিঙ্ক) একত্রীকরণ গুরুত্বপূর্ণ সমস্যা দেখা দেয় না কারণ বিভিন্ন প্যাকেজ এবং এইচটিএমএলে একটি TikZ ছবি এম্বেড করার জন্য সংশোধনের কারণে (উদাহরণস্বরূপ, TeX4ht) .
SciPy-এর মধ্যে গাইডগুলির ভবিষ্যত রক্ষণাবেক্ষণের প্রশ্নটি সহজে ব্যবহার করে সমাধান করা যেতে পারে, বলুন, Overleaf (সহযোগিতা সহজতর করে এবং একটি তাত্ক্ষণিক পূর্বরূপ অফার করে) এবং পূর্বনির্ধারিত টেমপ্লেটগুলি যা আমি সরবরাহ করব। মূলত, গ্রাফিকাল গাইডগুলি একে অপরের থেকে ব্যাপকভাবে পৃথক হওয়ার সম্ভাবনা নেই। গঠন, রঙ প্যালেট এবং আকারগুলি কমবেশি, অপরিবর্তনীয় হতে চলেছে, তাই পরবর্তী পুনঃআকৃতি এবং আরও কাস্টমাইজেশন একটি সমস্যা হবে না।
(অনুগ্রহ করে প্রস্তাবটির সম্পূর্ণ সংস্করণটি দেখুন - ভাগ করা GSoD ফোল্ডারে উপলব্ধ৷)