এই পৃষ্ঠায় Google সিজন অফ ডক্সের জন্য গৃহীত প্রযুক্তিগত লেখার প্রকল্পের বিশদ বিবরণ রয়েছে৷
প্রকল্পের সারসংক্ষেপ
- ওপেন সোর্স সংস্থা:
- OpenMRS.org
- কৌশলী লেখক:
- batbrain7
- প্রকল্পের নাম:
- OpenMRS REST API ডকুমেন্টেশন
- প্রকল্পের দৈর্ঘ্য:
- স্ট্যান্ডার্ড দৈর্ঘ্য (3 মাস)
প্রকল্প বর্ণনা
আমি আমার প্রস্তাবকে বিভিন্ন বিভাগে ভেঙে দেব এবং Google Maps API ডকুমেন্টেশন এবং Github API ডকুমেন্টেশনের মতো প্রবাহ অনুসরণ করব।
এগুলি ছাড়াও আমি API ডকুমেন্টেশনের জন্য একটি রিডমি কাঠামো প্রস্তাব করতে চাই যা realworld.io দ্বারা করা হয়: https://github.com/gothinkster/realworld/tree/master/api
ব্যক্তিগতভাবে, আমি এই ডকুমেন্টেশনটি বুঝতে এবং ব্যবহার করা খুব সহজ বলে মনে করেছি।
আমার প্রস্তাবে প্রধানত 3টি বিভাগ থাকবে:
একটি বিভাগ যা এপিআই সম্পর্কে, OpenMRS সম্পর্কে এবং কীভাবে এপিআই ব্যবহার করা হয় এবং এর পরে কী হয় সে সম্পর্কে একটি দ্রুত ভূমিকা দেবে।
API কী এবং প্রমাণীকরণ যা সাধারণভাবে API অনুরোধ করার জন্য প্রয়োজন তা কীভাবে পাবেন। এতে API-এ উপস্থিত প্রমাণীকরণের ধরনগুলির একটি নমুনা উদাহরণ থাকবে এবং এর জন্য কী এবং মানগুলি উপস্থিত থাকতে হবে, সেই অংশের কী-এর সাথে সঙ্গতিপূর্ণ মানগুলির ধরনগুলিও গৃহীত হবে৷ যেকোন ভাষায় একটি কোড নমুনা সহায়তা করবে এবং কীভাবে API-তে হেডার এবং প্রতিক্রিয়া বিন্যাস এবং অন্যান্য ক্যোয়ারী প্যারামিটার লিখতে হবে তা পরিষ্কার করবে।
API দ্বারা যে ধরনের প্রতিক্রিয়া পাওয়া যায়, JSON-এর ধরন বা অন্য কোনো ধরনের ফলাফল যা এপিআই দ্বারা ফেরত আসে তা উল্লেখ করতে হবে।
বিভিন্ন API রুট এবং সমস্ত প্যারামিটারের সাথে সেগুলি, শিরোনাম এবং অন্যান্য জিনিসপত্র পাঠাতে হবে। প্রতিটি API-কে কয়েকটি ভাষায় কোড নমুনা দ্বারা সহায়তা করা হবে যা বর্ণনা করে যে এটির জন্য কোড লেখার সময় কীভাবে অনুরোধ করা হয়, প্রতিটি API-এর সাথে সম্মুখীন হতে পারে এমন সাধারণ ত্রুটি কোডগুলিও উল্লেখ করা উচিত।
এটি REST API-এর জন্য ডকুমেন্টেশন কীভাবে সংজ্ঞায়িত করা হবে তার একটি সাধারণ ধারণা।
প্রকল্পের সময়সূচী নিম্নরূপ:
২১ আগস্ট-১৫ সেপ্টেম্বর
আমার পরামর্শদাতার সাথে পরিচিত হন এবং কোডবেসের বিভিন্ন অংশে প্রয়োজনীয় ডকুমেন্টেশনের স্তরের আরও গভীরতার সাথে আলোচনা করুন এবং নিম্ন স্তরের বনাম উচ্চ-স্তরের ডকুমেন্টেশনের মধ্যে কীভাবে গভীরভাবে যেতে হবে তাও আলোচনা করুন। আমি এই সময়টি কোডবেস বোঝার জন্য ব্যয় করব এবং ধারণাগুলি অধ্যয়ন করব যাতে আমি সেগুলি আরও ভালভাবে নথিভুক্ত করতে পারি।
সপ্তাহ 1 এবং 2
আমি অবদানকারীদের গাইড আপডেট এবং প্রসারিত করব। আমি সোর্স কোড কীভাবে তৈরি করতে হয় তার ডকুমেন্টেশন উন্নত করব। নতুন অবদানকারীরা কীভাবে ডকুমেন্টেশনে সাহায্য করতে পারে সে সম্পর্কে আমি একটি ডকুমেন্টার বিভাগও যোগ করব। আমি বিভিন্ন API ডকুমেন্টেশন অধ্যয়ন করব এবং ভূমিকা দিয়ে শুরু করব এবং API-এর জন্য প্রমাণীকরণ যোগ করব।
সপ্তাহ 3 - 8
আমি প্রতিটি ধরণের API এর জন্য কিছু কোড নমুনার সাথে API রুট এবং প্রতিক্রিয়া যোগ করব (এখানে একই ধরণের API থাকতে পারে)।
সপ্তাহ 9 এবং 10
লিঙ্কগুলি ব্যবহার করে API ডকুমেন্টেশন স্ট্রাকচার যোগ করুন, যেমন দীর্ঘ API ডকুমেন্টেশনের জন্য একটি লিঙ্কযুক্ত সূচী এবং এটিকে কোড বিভাগ, ওভারভিউ, প্যারামিটার, রুট এন্ডপয়েন্টের মতো ভিন্ন ভিত্তিতে ভাগ করুন।
শেষ সপ্তাহ
আমি আমার 12 সপ্তাহের ডকুমেন্টেশন সময়ের মধ্যে সম্পন্ন কাজের আমার চূড়ান্ত প্রতিবেদন প্রস্তুত করতে চূড়ান্ত সপ্তাহ ব্যবহার করব। আমি ডকুমেন্টেশন পর্যালোচনা এবং চূড়ান্ত করতে এই সময় ব্যয় করব।