এই পৃষ্ঠায় Google সিজন অফ ডক্সের জন্য গৃহীত প্রযুক্তিগত লেখার প্রকল্পের বিশদ বিবরণ রয়েছে৷
প্রকল্পের সারসংক্ষেপ
- ওপেন সোর্স সংস্থা:
- CERN-HSF
- কৌশলী লেখক:
- লাকইন দ্য রেইন
- প্রকল্পের নাম:
- রুট ডকুমেন্টেশন: বিশ্লেষণ, পুনর্গঠন এবং পুনর্লিখন
- প্রকল্পের দৈর্ঘ্য:
- দীর্ঘ চলমান (5 মাস)
প্রকল্প বর্ণনা
প্রকল্পটি চারটি পর্যায় নিয়ে গঠিত:
1.) বর্তমান রুট ডকুমেন্টেশন বিশ্লেষণ করা
সম্পূর্ণ রুট নথি (ওয়েব সাইট, ব্যবহারকারীদের নির্দেশিকা, C++ রেফারেন্স, টিউটোরিয়াল ইত্যাদি) নিম্নলিখিত মানদণ্ড অনুসারে বিশ্লেষণ এবং পরীক্ষা করা হয়: কাঠামো, মডুলারাইজেশন, মানককরণ, অ্যাক্সেস মেকানিজম, সামঞ্জস্য, তথ্যের ধরন, লক্ষ্য গোষ্ঠী-নির্দিষ্ট প্রস্তুতি এবং বোধগম্যতা উদ্দেশ্য তথ্য ব্যবস্থাপনার জন্য একটি ধারণা তৈরি করা এবং কাঠামোর জন্য একটি ম্যাট্রিক্স এবং বিষয়বস্তুকে মানসম্মত করার জন্য একটি নির্দেশিকা তৈরি করা।
2.) রুট টিমের সাথে একটি লেখার সফ্টওয়্যার ডকুমেন্টেশন গঠনের জন্য একটি পদ্ধতি সংজ্ঞায়িত করা
DITA (ডারউইন ইনফরমেশন টাইপিং আর্কিটেকচার), সফ্টওয়্যার ডকুমেন্টেশনের জন্য একটি OASIS স্ট্যান্ডার্ড ( https://www.oasis-open.org/committees/dita/ ) রুট টিমের কাছে উপস্থাপন করা হয়েছে। সফ্টওয়্যার-নির্দিষ্ট বিষয়বস্তু কীভাবে গঠন করা যায় এবং সফ্টওয়্যার ডকুমেন্টেশন লেখার জন্য "ধারণা", "টাস্ক" এবং "রেফারেন্স" হিসাবে প্রাথমিক তথ্যের ধরনগুলি কীভাবে ব্যবহার করা হয় তা বোঝার উপর প্রধান ফোকাস।
3.) রুট ডকুমেন্টেশনের পুনর্গঠন এবং পুনর্গঠন
প্রথম দুটি ধাপের ফলাফলের উপর ভিত্তি করে, ROOT ডকুমেন্টেশন পুনর্গঠন করা হয় এবং লক্ষ্য গোষ্ঠী, ভূমিকা এবং ব্যবহারের ক্ষেত্রে এবং বিষয়বস্তুগুলি সংশ্লিষ্ট উপাদানগুলিতে বরাদ্দ করা হয় (ওয়েব সাইট, ব্যবহারকারীদের নির্দেশিকা, C++ রেফারেন্স, টিউটোরিয়াল ইত্যাদি)। এবং বিষয়বস্তুর প্রকার। যেহেতু উপলব্ধ তথ্য খুব বিস্তৃত, তাই একটি সামঞ্জস্যপূর্ণ রেফারেন্স কাঠামোও স্থাপন করা আবশ্যক। উদ্দেশ্য হল একটি বিস্তৃত ওভারভিউ দেওয়া এবং ব্যবহারকারীদের তাদের প্রয়োজনের জন্য কীভাবে তারা রুট ব্যবহার করতে পারে তা স্পষ্টভাবে দেখানো। উপরন্তু, একটি কমপ্যাক্ট নন-ফিজিক্স ওরিয়েন্টেড ভূমিকা প্রদান করা হয়।
4.) রুট ডকুমেন্টেশন পুনরায় লেখা
ডকুমেন্টেশনের প্রধান অংশগুলি, বিশেষ করে ব্যবহারকারীর নির্দেশিকা, DITA পদ্ধতির সাথে সঙ্গতি রেখে পুনরায় লেখা হয়েছে। ভবিষ্যতে নথিতে ধারাবাহিকতা নিশ্চিত করার জন্য কাঠামো এবং লেখার নিয়মগুলি একটি স্টাইল গাইডে রেকর্ড করা হয়। লক্ষ্য হল রুট দলকে ভবিষ্যতে রুট ডকুমেন্টেশন নিজেদের প্রসারিত ও বজায় রাখতে সক্ষম করা।
আনুমানিক সময়সূচী (5 মাস):
পর্যায় 1: বর্তমান রুট ডকুমেন্টেশন বিশ্লেষণ করুন: 3 সপ্তাহ।
পর্যায় 2: রুট টিমের সাথে একটি লেখার সফ্টওয়্যার ডকুমেন্টেশন গঠনের জন্য একটি পদ্ধতি সংজ্ঞায়িত করা: 2 সপ্তাহ।
পর্যায় 3: রুট ডকুমেন্টেশনের পুনর্গঠন এবং পুনর্গঠন: 4 সপ্তাহ।
পর্যায় 4: রুট ডকুমেন্টেশন পুনরায় লেখা: 11 সপ্তাহ।