অধ্যায় 4 · ডিজাইন ও কোড
সফটওয়্যার ডিজাইনের মূল কথা: রিকোয়ারমেন্ট থেকে মডিউল
- পৃষ্ঠা 11 / 18
- 16 মিনিট পড়া
রিকোয়ারমেন্ট বলে ClinicQueue-কে কী করতে হবে: রোগীরা স্লট বুক করবেন, রিমাইন্ডার পাবেন, আর ফ্রন্ট ডেস্ক কিউ দেখবে। ভেতরে সফটওয়্যারটা কীভাবে সাজানো হবে, তা রিকোয়ারমেন্ট বলে না। ফারহান আর আইকো যদি সোজা কোড লিখতে শুরু করেন, প্রথম ভার্সন হয়তো চলবে, কিন্তু পরের প্রতিটা পরিবর্তন সবকিছু ছুঁয়ে যাবে, আর দুজন মানুষ একে অপরের পা না মাড়িয়ে একসাথে এতে কাজ করতে পারবেন না। সফটওয়্যার ডিজাইন (software design) হলো মাঝখানের ধাপ: সিস্টেমের অংশগুলো কী হবে, প্রতিটা অংশের দায়িত্ব কী, আর অংশগুলো একে অপরের সাথে কীভাবে কথা বলবে, তা ঠিক করা।
আগের পাতা রিস্ক ম্যানেজমেন্ট শেষ হয়েছিল একটা রিস্ক রেজিস্টার দিয়ে। এর কয়েকটা প্রতিক্রিয়া আসলে ছিল ডিজাইনের সিদ্ধান্ত: "তারিখ আর সময় বসায় আমাদের নিজের কোড, AI মডেল নয়" হলো সিস্টেমের কোন অংশ কী করবে, সেই সিদ্ধান্ত। এই পাতা আপনাকে এমন সিদ্ধান্ত সচেতনভাবে নেওয়ার শব্দভান্ডার আর অভ্যাস দেবে। এটা অধ্যায় ৪-এর শুরু, যেখানে পরিকল্পনা রূপ নেয় বানানোর কাজে।
যা শিখবেন
- ডিজাইনের দুই স্তর: আর্কিটেকচারাল (উঁচু স্তরের) আর ডিটেইলড (নিচু স্তরের)।
- মডিউলারিটি, কোহেশন, কাপলিং আর সেপারেশন অব কনসার্নস, ClinicQueue থেকে ভালো ও খারাপ উদাহরণসহ।
- ClinicQueue-এর জন্য একটা সহজ লেয়ারড আর্কিটেকচার (UI, API, লজিক, ডেটা), টেক্সট কম্পোনেন্ট ডায়াগ্রাম হিসেবে আঁকা।
- মডিউলের মধ্যে ইন্টারফেস কীভাবে কাজ করে, আর প্রত্যাশিত পরিবর্তনের জন্য কীভাবে ডিজাইন করবেন।
- একটা ডিজাইন রিভিউ চেকলিস্ট, আর KISS, DRY ও YAGNI-কে আইন নয়, কাজের নিয়ম (rule of thumb) হিসেবে দেখা।
রিকোয়ারমেন্ট থেকে ডিজাইন: দুই স্তর
ডিজাইন হয় দুই স্তরে। দুটোই দরকার, কিন্তু এরা আলাদা প্রশ্নের উত্তর দেয়, আর আলাদা সময়ে করা হয়।
আর্কিটেকচারাল (উঁচু স্তরের) ডিজাইন
আর্কিটেকচার (architecture) হলো বড় ছবিটা: সিস্টেমের প্রধান অংশগুলো, তারা কীভাবে যোগাযোগ করে, ডেটা কোথায় রাখা হয়, আর কোন বাইরের সার্ভিস ব্যবহার হয়। ClinicQueue-এর জন্য: রোগী আর ফ্রন্ট ডেস্কের জন্য একটা ওয়েব ফ্রন্ট এন্ড, বুকিংয়ের নিয়ম রাখে এমন একটা ব্যাকএন্ড, একটা ডেটাবেস, একটা SMS সার্ভিস, আর টেক্সটের খসড়া করার জন্য একটা AI মডেল। আর্কিটেকচারের সিদ্ধান্ত পরে বদলানো ব্যয়বহুল, কারণ অনেক অন্য সিদ্ধান্ত এর ওপর নির্ভর করে। লঞ্চের পরে "ফাইলে বুকিং" থেকে "ডেটাবেসে বুকিং"-এ যাওয়া কোডের প্রায় প্রতিটা অংশ ছুঁয়ে যেত।
ডিটেইলড (নিচু স্তরের) ডিজাইন
ডিটেইলড ডিজাইন (detailed design) কাজ করে একটা অংশের ভেতরে: এতে কোন ফাংশন বা ক্লাস থাকবে, সেগুলো কী ডেটা নেয় আর ফেরত দেয়, কোন নিয়ম প্রয়োগ করে, আর কিছু ব্যর্থ হলে কী হয়। বুকিং মডিউলের জন্য: একটা স্লট খালি কি না কীভাবে যাচাই হবে, দুজন রোগী ঠিক একই মুহূর্তে "Book" চাপলে কী হবে, আর রোগী কোন ত্রুটির বার্তা দেখবেন।
| আর্কিটেকচারাল ডিজাইন | ডিটেইলড ডিজাইন | |
|---|---|---|
| প্রশ্ন | প্রধান অংশগুলো কী, আর সেগুলো কীভাবে যুক্ত? | এই একটা অংশ ভেতরে কীভাবে কাজ করে? |
| সাধারণ আউটপুট | কম্পোনেন্ট ডায়াগ্রাম, বাইরের সার্ভিসের তালিকা, প্রযুক্তি বাছাই | ফাংশন আর ডেটার বর্ণনা, নিয়ম, ত্রুটির ক্ষেত্র, কখনো কোডের একটা খসড়া |
| কখন | আগে, বেশিরভাগ কোডের আগে; বড় রিকোয়ারমেন্ট বদলালে আবার দেখা হয় | প্রতিটা ফিচার বানানোর ঠিক আগে বা বানানোর সময় |
| ভুলের দাম | বেশি: অনেক অংশ এর ওপর নির্ভর করে | সাধারণত কম: একটা অংশে সীমাবদ্ধ |
| ClinicQueue-এর উদাহরণ | "ফ্রন্ট এন্ড ব্যাকএন্ডের সাথে শুধু একটা API দিয়ে কথা বলে" | "book_slot অতীতের স্লট আর এর মধ্যেই নেওয়া স্লট প্রত্যাখ্যান করে" |
কোডিংয়ের আগে কতটা ডিজাইন করা উচিত? কঠোরভাবে ধারাবাহিক প্রসেস (প্রসেস মডেল: ওয়াটারফল, ইনক্রিমেন্টাল, RAD ও বিগ ব্যাং পাতার ওয়াটারফল মডেল) সব ডিজাইন আগেই করে ফেলতে চায়। অ্যাজাইল টিম সাধারণত আর্কিটেকচারের একটা খসড়া আগে করে, আর ডিটেইলড ডিজাইন করে স্টোরি ধরে ধরে, কারণ রিকোয়ারমেন্ট বদলাবে। দুই পক্ষেরই যুক্তি আছে: আগে খুব কম ডিজাইন করলে এমন জট পাকে, যা বদলাতে কষ্ট; খুব বেশি করলে এমন ফিচারের বিস্তারিত ডকুমেন্ট তৈরি হয়, যেগুলো পরে বাদ পড়ে। ClinicQueue-এর জন্য লেনার টিম প্রথম স্প্রিন্টের আগে এক বিকেল আর্কিটেকচারে দেয়, আর প্রতিটা স্টোরির খুঁটিনাটি ডিজাইন করে স্প্রিন্টের মধ্যে।
মডিউল, কোহেশন আর কাপলিং
মডিউল (module) হলো প্রোগ্রামের এমন একটা অংশ, যার স্পষ্ট দায়িত্ব আর স্পষ্ট সীমানা আছে: Python-এ প্রায়ই একটা ফাইল বা ছোট একটা প্যাকেজ। মডিউলারিটি মানে এমন অংশ দিয়ে সিস্টেম গড়া। ভালো মডিউল থাকলে একজন মানুষ সবকিছু না পড়েই একটা অংশ বুঝতে পারেন, সেটা আলাদা করে টেস্ট করতে পারেন, বাকিটা না ভেঙে বদলাতে পারেন, আর কয়েকজন একসাথে কাজ করতে পারেন।
দুটো ধারণা বলে দেয় আপনার মডিউলগুলো ভালো কি না। দুটোই Stevens, Myers আর Constantine-এর ১৯৭৪ সালের "Structured Design" পেপারে বিস্তারিত বলা হয়েছিল, আর আজও ব্যবহার হয়।
কোহেশন: ভেতরের জিনিসগুলো একসাথে মানায় কি না
কোহেশন (cohesion) হলো একটা মডিউলের ভেতরের অংশগুলো কতটা ঘনিষ্ঠভাবে একসাথে মানায়। উঁচু কোহেশন ভালো: মডিউলের সবকিছু একটা উদ্দেশ্যে কাজ করে। নিচু কোহেশন মানে মডিউলটা অসম্পর্কিত জিনিসের একটা ড্রয়ার।
উদাহরণ:
Low cohesion High cohesion
helpers.py booking.py free_slots, book_slot, cancel_booking
format_date() reminders.py reminders_due, send_reminder
send_sms() queue.py todays_queue, mark_arrived
is_slot_free() sms_gateway.py send_sms
backup_database() formatting.py format_date, format_time
calculate_waiting_time()বাঁ দিকে, SMS পাঠানো, তারিখের ফরম্যাট আর ব্যাকআপের পরিবর্তন সবই একই ফাইল সম্পাদনা করে, আর helpers.py কীসের জন্য তা কেউ বলতে পারে না। ডান দিকে, প্রতিটা ফাইলের উদ্দেশ্য এক বাক্যে বলা যায়। একটা ভালো পরীক্ষা: "এবং" শব্দ ছাড়া কোনো মডিউলের বর্ণনা দিতে না পারলে সম্ভবত তার কোহেশন নিচু।
কাপলিং: মডিউলগুলো একে অপরের ওপর কতটা নির্ভর করে?
কাপলিং (coupling) হলো একটা মডিউল আরেকটার ভেতরের ওপর কতটা নির্ভর করে। নিচু (ঢিলা) কাপলিং ভালো: মডিউলগুলো একে অপরকে ব্যবহার করে শুধু ছোট, স্থির কিছু ফাংশনের মাধ্যমে। উঁচু (আঁটসাঁট) কাপলিং মানে একটা মডিউলের ভেতরের পরিবর্তন অন্যগুলো ভেঙে দেয়।
উদাহরণ:
Tight coupling:
queue screen code runs its own query on the bookings table, and relies on the column
names "slot_start" and "status" and on status == 2 meaning "arrived".
Farhan renames a column or adds a new status -> Rina's queue screen breaks.
Loose coupling:
queue screen calls todays_queue(date) from queue.py and gets a list of
(time, patient name, doctor, arrived yes/no).
Farhan changes the table design -> he updates queue.py; the screen does not change.কিছু কাপলিং এড়ানো যায় না; যে মডিউলগুলো কখনো কথা বলে না, সেগুলো মিলে কোনো সিস্টেম হয় না। লক্ষ্য হলো এরা অন্য মডিউল কী দেয় তার ওপর নির্ভর করবে, কীভাবে করে তার ওপর নয়। উঁচু কোহেশন আর নিচু কাপলিং সাধারণত একসাথে আসে: প্রতিটা মডিউলের একটা স্পষ্ট কাজ থাকলে অন্যগুলো সম্পর্কে তার কম জানলেই চলে।
সেপারেশন অব কনসার্নস
কনসার্ন (concern) হলো সফটওয়্যারকে যে ধরনের কাজ সামলাতে হয় তার একেকটা: তথ্য দেখানো, ব্যবসার নিয়ম প্রয়োগ, ডেটা রাখা, বাইরের সার্ভিসের সাথে কথা বলা। সেপারেশন অব কনসার্নস (separation of concerns) মানে প্রতিটা ধরনকে নিজের জায়গায় রাখা। ClinicQueue-এ নতুনদের একটা সাধারণ ভুল হতো "একজন রোগী দিনে একটাই বুকিং রাখতে পারবেন" নিয়মটা শুধু ব্রাউজারের পাতায় রাখা। তখন নিয়মটা থাকে দেখানোর কোডে, আর দ্বিতীয় কোনো ফ্রন্ট এন্ড (যেমন সরাসরি আসা রোগীদের বুক করতে রিনার জন্য একটা পাতা) সেটা আবার লিখবে, বা ভুলে যাবে। নিয়মের জায়গা লজিক অংশে, যেখান দিয়ে বুকিংয়ের প্রতিটা পথ যায়।
ClinicQueue-এর জন্য একটা লেয়ারড আর্কিটেকচার
লেয়ারড আর্কিটেকচার (layered architecture) কনসার্ন আলাদা করার সবচেয়ে সহজ আর প্রচলিত উপায়গুলোর একটা। প্রতিটা লেয়ারের এক ধরনের কাজ, আর সেটা শুধু ঠিক নিচের লেয়ারটা ব্যবহার করে। ClinicQueue চারটা লেয়ার ব্যবহার করে, সাথে বাইরের সার্ভিসের জন্য অ্যাডাপ্টার।
উদাহরণ:
+----------------------------------------------------------------------------------+
| UI layer (browser) |
| Patient booking pages (Aiko) Front-desk queue screen (Aiko, for Rina) |
+----------------------------------------+-----------------------------------------+
| HTTP requests and JSON responses
+----------------------------------------v-----------------------------------------+
| API layer /slots /bookings /queue /reminders |
| checks who is calling and what they may do; turns requests into calls below |
+----------------------------------------+-----------------------------------------+
| function calls
+----------------------------------------v-----------------------------------------+
| Logic layer booking queue reminders |
| clinic rules: free slots, one booking per day, who is next, when to remind |
+-----------------+----------------------+---------------------+-------------------+
| function calls | |
+-----------------v----------------+ +-v-------------+ +---v-------------------+
| Data layer | | SMS adapter | | Text-drafting adapter |
| patients, slots, bookings | | sms_gateway | | ai_drafts |
+-----------------+----------------+ +-------+-------+ +-----------+-----------+
| | |
[ Database ] [ SMS provider ] [ AI model service ]একটা রিকোয়েস্ট ধরে এর ভেতর দিয়ে চলুন। একজন রোগী চাপলেন "Book 10:30 with Dr. Rahman"। বুকিং পাতা (UI) /bookings-এ (API) একটা রিকোয়েস্ট পাঠায়। API যাচাই করে রিকোয়েস্টটা ঠিকঠাক গঠনের কি না, আর বুকিং মডিউলের (লজিক) book_slot ডাকে, যেটা ক্লিনিকের নিয়মগুলো যাচাই করে ডেটা লেয়ারকে বুকিংটা সেভ করতে বলে। ডেটা লেয়ার ডেটাবেসে লেখে; উত্তর ওপরে ফিরে যায়, আর পাতা দেখায় "Booked"। পরে রিমাইন্ডার মডিউল SMS অ্যাডাপ্টারকে একটা মেসেজ পাঠাতে বলে। কোনো সময়েই পাতা সরাসরি ডেটাবেস বা SMS প্রোভাইডারের সাথে কথা বলে না।
এতে টিম যা পায়:
- কাজ ভাগ করা যায়: আইকো API-এর বর্ণনা ধরে UI বানান, ততক্ষণে ফারহান লজিক আর ডেটা লেয়ার বানান।
- নিয়ম থাকে এক জায়গায়: রোগীর পাতা আর ভবিষ্যতের সরাসরি-আসা রোগীর পাতা দুটোই একই বুকিং লজিক দিয়ে যায়।
- বাইরের সার্ভিস বদলানো যায়: ক্লিনিক SMS প্রোভাইডার বদলালে শুধু
sms_gatewayবদলায়। - টেস্টিং সহজ হয়: কোয়ামে আর ডেভেলপাররা ব্রাউজার ছাড়া আর আসল SMS না পাঠিয়েই বুকিংয়ের নিয়ম টেস্ট করতে পারেন।
লেয়ারেরও দাম আছে: বেশি ফাইল, আর একটা ছোট পরিবর্তনকে কখনো কয়েকটা লেয়ার পেরোতে হয়। এক সন্ধ্যার একটা স্ক্রিপ্টের জন্য এটা বাড়াবাড়ি। বড় কাঠামো নিয়েও টিমগুলো তর্ক করে, যেমন একটা সিস্টেমকে আলাদা আলাদা ডিপ্লয় হওয়া অনেকগুলো সার্ভিসে ভাগ করা। একটা ক্লিনিক অ্যাপ বানানো পাঁচজনের টিমের জন্য স্পষ্ট লেয়ারসহ একটা অ্যাপ্লিকেশনই সহজ আর নিরাপদ বাছাই; কখনো দরকার হলে পরে ভাগ করা যাবে।
ইন্টারফেস আর পরিবর্তনের জন্য ডিজাইন
ইন্টারফেস: মডিউলগুলোর মধ্যে চুক্তি
ইন্টারফেস (interface) হলো একটা মডিউল বাকি সিস্টেমকে যা দেয়: ফাংশন বা এন্ডপয়েন্টগুলো, সেগুলো কী নেয়, কী ফেরত দেয়, আর কোন ত্রুটি দিতে পারে। বাকি সবকিছু মডিউলের নিজস্ব ব্যাপার। ভেতরটা ছোট একটা ইন্টারফেসের পেছনে লুকিয়ে রাখা (প্রায়ই একে ইনফরমেশন হাইডিং, information hiding বলে) ঢিলা কাপলিং সম্ভব করে।
উদাহরণ:
Module: sms_gateway (used only by the reminders module)
send_sms(phone, text) -> delivery_id
phone: international format, for example "+8801000000000"
text: at most 160 characters
returns an id that can be used to ask for the delivery status
errors: InvalidPhone (bad number), ProviderUnavailable (try again later)
delivery_status(delivery_id) -> "sent" | "delivered" | "failed"
Not part of the interface: which provider is used, its web address, keys, retry rules.এটা লেখা থাকলে ফারহান প্রোভাইডার বদলাতে, নতুন করে চেষ্টা (retry) যোগ করতে বা প্রতিটা মেসেজ লগ করতে পারেন, রিমাইন্ডার মডিউল টেরও পায় না। মানুষে মানুষে বাগ তৈরি করে এমন খুঁটিনাটির জন্যও ইন্টারফেস ভালো জায়গা: একক, ফরম্যাট, সীমা আর ত্রুটির ক্ষেত্র। প্রজেক্ট ম্যানেজমেন্ট ও সফটওয়্যার টিমের ভূমিকা পাতায় স্ট্যান্ড-আপে আইকোর বাধাটা ("API টাইম জোন ছাড়া সময় ফেরত দেয়") ঠিক এমনই একটা ইন্টারফেসের খুঁটিনাটি, যা কেউ লিখে রাখেনি।
পরিবর্তনের জন্য ডিজাইন: "এখানে কী বদলাবে?"
যে সফটওয়্যার ব্যবহার হয়, তা বদলায়। প্রতিটা পরিবর্তন আগে থেকে বলা যায় না, কিন্তু ডিজাইনের প্রতিটা অংশের জন্য জিজ্ঞেস করা যায় "এখানে কী বদলানোর সম্ভাবনা আছে?", আর সেগুলো সহজে বদলানোর মতো রাখা যায়।
| সম্ভাব্য পরিবর্তন | ডিজাইনের প্রতিক্রিয়া |
|---|---|
| ক্লিনিক SMS প্রোভাইডার বদলায় (দাম, কভারেজ) | প্রোভাইডারের সব খুঁটিনাটি sms_gateway-এর ভেতরে, তার ইন্টারফেসের পেছনে থাকে |
| AI খসড়ার সার্ভিস বদলায়, দামি হয়ে যায়, বা বন্ধ করতে হয় (রিস্ক রেজিস্টার) | খসড়ার কাজ থাকে ai_drafts-এর পেছনে, বিকল্প হিসেবে একটা নির্দিষ্ট টেমপ্লেটসহ; তারিখ আর সময় আসে বুকিং থেকে, কখনো মডেল থেকে নয় |
| খোলার সময়, স্লটের দৈর্ঘ্য, রিমাইন্ডারের সময় | নাদিয়ার কর্মীরা বদলাতে পারেন এমন সেটিং, কোডে লিখে রাখা সংখ্যা নয় |
| বুকিংয়ের নতুন একটা পথ (ডেস্কে সরাসরি-আসা রোগীর পাতা) | বুকিংয়ের নিয়ম লজিক লেয়ারে, তাই নতুন স্ক্রিনের শুধু API দরকার |
| কোনো দিন দ্বিতীয় একটা ক্লিনিক | এখন এর জন্য ডিজাইন করা হয় না (নিচে YAGNI দেখুন); লেয়ারগুলো পরিষ্কার রাখলেই পরে এটা সম্ভব থাকে |
শেষ সারিটা বাকিগুলোর মতোই জরুরি। কল্পনা করা যায় এমন প্রতিটা পরিবর্তনের জন্য ডিজাইন করলে সিস্টেম বড় হয়, বানাতে দেরি হয়, আর বোঝা কঠিন হয়। যে পরিবর্তন আশা করার কারণ আছে, তার জন্য ডিজাইন করুন; বাকিগুলোর জন্য কোড পরিষ্কার রাখুন, যাতে সময় এলে বদলানো কঠিন না হয়।
ডিজাইন রিভিউ
ডিজাইন রিভিউ চেকলিস্ট
ডিজাইন রিভিউ (design review) হলো একটা ছোট মিটিং বা লিখিত আলোচনা, যেখানে বেশি কোড হওয়ার আগেই ডিজাইনার ছাড়া অন্যরা ডিজাইনটা যাচাই করেন। এখানে পাওয়া সমস্যা ঠিক করা সস্তা: আপনি একশোটা ফাইল নয়, একটা ডায়াগ্রাম বদলান। নন-ফাংশনাল রিকোয়ারমেন্টের জন্য যে ISO/IEC 25010:2023 মানের বৈশিষ্ট্যগুলো ব্যবহার করেছিলেন (যেমন পারফরম্যান্স এফিশিয়েন্সি, সিকিউরিটি, মেইনটেইনেবিলিটি আর ফ্লেক্সিবিলিটি), সেগুলো প্রশ্নের একটা ভালো উৎস।
| প্রশ্ন | কেন জরুরি |
|---|---|
| প্রতিটা রিকোয়ারমেন্টের ডিজাইনে একটা জায়গা আছে কি না? | যে রিকোয়ারমেন্টের কোনো মডিউল নেই, সেটা ভুলে যাওয়া হবে |
| প্রতিটা মডিউলের উদ্দেশ্য এক বাক্যে বলা যায় কি না? | কোহেশন যাচাই |
| কোনো মডিউল আরেকটার ভেতরের জিনিস (টেবিল, প্রাইভেট ফাংশন) ব্যবহার করে কি না? | কাপলিং যাচাই |
| ইন্টারফেসগুলো ফরম্যাট, সীমা আর ত্রুটিসহ লেখা আছে কি না? | বেশিরভাগ ইন্টিগ্রেশন বাগ এখানেই থাকে |
| প্রতিটা বাইরের সার্ভিস ব্যর্থ বা ধীর হলে কী হয়? | SMS আর AI সার্ভিস কখনো কখনো ব্যর্থ হবেই |
| ব্যক্তিগত ডেটা কোথায় রাখা হয়, আর কে সেখানে পৌঁছাতে পারে? | নিরাপত্তা; রোগীর ডেটা |
| রেজিস্টারের HIGH ঝুঁকিগুলো ডিজাইনে সামলানো হয়েছে কি না? | যেমন, ডাবল বুকিং আটকায় ডেটা লেয়ারের একটা নিয়ম, শুধু পাতা নয় |
| কী বদলানোর সম্ভাবনা আছে, আর সেটা সহজে বদলানো যায় কি না? | পরিবর্তনের জন্য ডিজাইন |
| একই রিকোয়ারমেন্ট মেটায় এমন সহজতর কোনো ডিজাইন আছে কি না? | জটিলতার দাম প্রতিদিন দিতে হয় |
KISS, DRY আর YAGNI: কাজের নিয়ম
ডেভেলপারদের মধ্যে তিনটা ছোট স্লোগান জনপ্রিয়। এগুলো কাজে লাগার মতো স্মারক, আইন নয়, আর কখনো কখনো একে অপরের বিপরীতে টানে।
- KISS, "keep it simple" (সহজ রাখুন): রিকোয়ারমেন্ট মেটায় এমন সবচেয়ে সহজ ডিজাইনটা বেছে নিন। সময় ধরে সাজানো আজকের বুকিংয়ের একটা সাধারণ তালিকা এমন চতুর রিয়েল-টাইম পূর্বাভাসের ইঞ্জিনের চেয়ে ভালো কিউ স্ক্রিন, যা কেউ চায়নি।
- DRY, "don't repeat yourself" (নিজেকে পুনরাবৃত্তি করবেন না): প্রতিটা জ্ঞান এক জায়গায় থাকা উচিত। "রোগীপ্রতি দিনে একটা বুকিং" নিয়মটা একবারই লেখা উচিত, বুকিং মডিউলে। কিন্তু দুটো কোড আজ দেখতে এক রকম বলেই সেগুলো জুড়ে দেবেন না: রিমাইন্ডারের মেসেজ আর রসিদের মেসেজের ফরম্যাট যদি কাকতালীয়ভাবে এক হয়, কিন্তু আলাদা কারণে বদলায়, তাহলে এগুলো জোড়া দিলে এমন দুটো জিনিস কাপলড হয়ে যায়, যাদের আলাদাভাবে বদলানোর স্বাধীনতা থাকা উচিত।
- YAGNI, "you aren't gonna need it" (এটা আপনার লাগবে না): শুধু কল্পনা করা দরকারের জন্য ফিচার বা নমনীয়তা বানাবেন না। "যদি লাগে" ভেবে অনেক ক্লিনিক, অনেক ভাষা আর অনেক SMS প্রোভাইডার সমর্থন করলে v1-এর কাজ তিনগুণ হয়ে যেত।
কাল্পনিক পরিস্থিতি:
Design review, before sprint 1.
Farhan: "Let us build a plug-in system so the clinic can choose any SMS provider."
Kwame: "YAGNI? We have one provider and no plan to change."
Lena: "But the risk register says the provider may fail or get expensive."
Outcome: no plug-in system. One small sms_gateway module with a written interface,
so switching provider later means rewriting one file, not the whole app.এটা একটা সাধারণ সমাধান: YAGNI বড়, সর্বজনীন একটা ব্যবস্থাকে না বলে, আর পরিবর্তনের জন্য ডিজাইন পরিষ্কার একটা সীমানাকে হ্যাঁ বলে। পরিষ্কার ইন্টারফেস এখন সস্তা, আর পরের পরিবর্তনটাকেও সস্তা রাখে।
কাজের জায়গায় এটা কোথায় লাগে
- বড় কোনো ফিচারের আগে অনেক টিম একটা ছোট ডিজাইন নোট লেখে (এক-দুই পাতা, একটা ডায়াগ্রামসহ), আর কোডিং শুরুর আগে সহকর্মীদের রিভিউ করতে বলে।
- টেকনিক্যাল ইন্টারভিউতে প্রায়ই "একটা ছোট সিস্টেম ডিজাইন করুন" ধরনের প্রশ্ন থাকে; ইন্টারভিউয়াররা একটা সঠিক উত্তর নয়, অংশ, দায়িত্ব, ইন্টারফেস আর টানাপোড়েনের কথা শুনতে চান।
- কোড রিভিউ প্রায়ই ডিজাইনের মন্তব্যে গড়ায়: "এই পাতা সরাসরি ডেটাবেসের সাথে কথা বলে" একটা কাপলিংয়ের মন্তব্য।
- বাইরের কোনো সার্ভিস দাম বদলালে বা বন্ধ হয়ে গেলে পরিষ্কার অ্যাডাপ্টার থাকা টিম কয়েক দিনে বদলে নেয়; যে টিমের কোডজুড়ে সার্ভিসের খুঁটিনাটি ছড়ানো, তাদের লাগে কয়েক সপ্তাহ।
সাধারণ ভুল
- রিকোয়ারমেন্ট থেকে সোজা কোডে যাওয়া। প্রথম ফিচার চলে, আর পরের প্রতিটা কঠিন হতে থাকে। সমাধান: আগে প্রধান অংশ আর তাদের ইন্টারফেসের একটা খসড়া করুন, এক পাতায় হলেও।
- চিরকাল বাড়তে থাকা "helpers" বা "utils" মডিউল। নিচু কোহেশন: সব পরিবর্তন একটা ফাইলে। সমাধান: প্রতিটা ফাংশনকে তার উদ্দেশ্যের নামে একটা ঘর দিন।
- যে স্ক্রিন সরাসরি ডেটাবেসের সাথে কথা বলে। আঁটসাঁট কাপলিং: টেবিল বদলালে UI ভাঙে, আর নিয়ম প্রতিটা স্ক্রিনে কপি হয়। সমাধান: API আর লজিক লেয়ার দিয়ে যান।
- যে ইন্টারফেস শুধু মানুষের মাথায় থাকে। ফরম্যাট, একক আর ত্রুটি দুই দিকে আলাদাভাবে অনুমান করা হয়। সমাধান: সীমা আর ত্রুটির ক্ষেত্রসহ প্রতিটা ইন্টারফেস লিখে রাখুন।
- "ভবিষ্যতের জন্য" বাড়াবাড়ি ইঞ্জিনিয়ারিং। কারও নেই এমন দরকারের জন্য নমনীয় ফ্রেমওয়ার্ক রিলিজ পিছিয়ে দেয় আর টিমকে বিভ্রান্ত করে। সমাধান: যে পরিবর্তন আশা করার কারণ আছে তার জন্য ডিজাইন করুন, বাকিটা সহজ আর পরিষ্কার রাখুন।
নিজে চেষ্টা করুন
- সহজ:
clinic.pyফাইলে আছে:book_slot,send_sms,draw_queue_table_html,backup_databaseআরcount_no_shows_last_month। ডিজাইনের সমস্যাটার নাম বলুন, আর মডিউলে আরও ভালো একটা ভাগ প্রস্তাব করুন। - মাঝারি: প্রতিটা জিনিসকে ClinicQueue আর্কিটেকচারের একটা লেয়ারে বসান (UI, API, লজিক, ডেটা, বা একটা অ্যাডাপ্টার): (ক) "সরকারি ছুটির দিনে কোনো বুকিং নয়" নিয়ম; (খ) কিউ স্ক্রিনের বোতামের রং; (গ)
/queueযিনি ডাকছেন তিনি ফ্রন্ট ডেস্কের কর্মী কি না যাচাই; (ঘ) বুকিং সেভ করার SQL স্টেটমেন্ট; (ঙ) AI মডেল সার্ভিসকে ডাকার কোড। - কঠিন: নাদিয়া এখন SMS-এর পাশাপাশি ইমেইলেও রিমাইন্ডার চান, কোনটা তা রোগী বেছে নেবেন। এই পাতার লেয়ারড আর্কিটেকচার আর
sms_gatewayইন্টারফেস ধরে বর্ণনা করুন কোন মডিউল বদলায়, কোনগুলো বদলায় না, আর আপনি নতুন কোন একটা ইন্টারফেস লিখবেন। তারপর এমন একটা জিনিসের নাম বলুন, যা আপনি ইচ্ছা করে এখনই বানাবেন না, আর কেন।
উত্তর
- সমস্যা হলো নিচু কোহেশন: একটা মডিউলে বুকিংয়ের নিয়ম, SMS পাঠানো, HTML দেখানো, ডেটাবেস ব্যাকআপ আর রিপোর্টিং মিশে আছে, তাই অসম্পর্কিত পরিবর্তনগুলো একই ফাইলে ধাক্কা খায়, আর এর কোনো একক উদ্দেশ্য নেই। আরও ভালো ভাগ:
booking.py(book_slot),sms_gateway.py(send_sms), কিউ স্ক্রিনের নিজস্ব UI কোড (draw_queue_table_html), ব্যাকআপের জন্য একটা অপারেশন স্ক্রিপ্ট বা মডিউল (backup_database), আরreports.py(count_no_shows_last_month)। ভালো উত্তরে কোহেশনের নাম থাকে (আর সম্ভবত কাপলিংয়েরও, কারণclinic.pyইমপোর্ট করা সবকিছু সবকিছুর ওপর নির্ভর করে), প্রতিটা নতুন মডিউলের এক বাক্যের উদ্দেশ্য থাকে, আর দেখানোর কোড লজিকের বাইরে থাকে। - (ক) লজিক লেয়ার, বুকিং মডিউলে: এটা ক্লিনিকের নিয়ম, আর বুকিংয়ের প্রতিটা পথকে এটা মানতে হবে। (খ) UI লেয়ার। (গ) API লেয়ার: কে ডাকছেন আর তিনি কী করতে পারেন, তা এখানে যাচাই হয়। (ঘ) ডেটা লেয়ার। (ঙ) একটা অ্যাডাপ্টার (
ai_drafts), যেটা লজিক লেয়ারের রিমাইন্ডার মডিউল ব্যবহার করে। - নমুনা উত্তর: "নতুন একটা অ্যাডাপ্টার যোগ করুন,
email_gateway,sms_gateway-এর মতো করে, যার ইন্টারফেস হবেsend_email(address, subject, text) -> delivery_idআরdelivery_status(delivery_id)। রিমাইন্ডার মডিউল বদলায়: এটা রোগীর বেছে নেওয়া মাধ্যম পড়ে ঠিক অ্যাডাপ্টারটা ডাকে। ডেটা লেয়ার একটু বদলায়: রোগীদের একটা ইমেইল ঠিকানা আর একটা 'রিমাইন্ডারের মাধ্যম' ফিল্ড যোগ হয়। UI বদলায়: বুকিং পাতা মাধ্যমটা জিজ্ঞেস করে। বুকিং মডিউল, কিউ মডিউল, কিউ স্ক্রিন আরsms_gatewayবদলায় না। আমি এখনই সাধারণ একটা 'যেকোনো মাধ্যম' প্লাগ-ইন ব্যবস্থা বানাব না: মাধ্যম দুটো, আর বেশি চাওয়া হয়নি (YAGNI); তৃতীয় কোনো মাধ্যম এলে এই দুটো মিল-থাকা অ্যাডাপ্টার দেখিয়ে দেবে একটা যৌথ ইন্টারফেস কেমন হওয়া উচিত।" ভালো উত্তরে বদলানো আর না-বদলানো মডিউলের তালিকা থাকে, মাধ্যম বাছাইয়ের নিয়ম UI-তে নয়, লজিক লেয়ারে রাখা হয়, ত্রুটি বা স্ট্যাটাসসহ একটা নির্দিষ্ট ইন্টারফেস লেখা থাকে, আর যা বাদ রাখা হলো তার কারণ থাকে।
সারসংক্ষেপ
- ডিজাইন রিকোয়ারমেন্টকে একটা কাঠামোয় রূপ দেয়: আর্কিটেকচারাল ডিজাইন ঠিক করে প্রধান অংশ আর তাদের সংযোগ; ডিটেইলড ডিজাইন ঠিক করে প্রতিটা অংশ ভেতরে কীভাবে কাজ করবে।
- ভালো মডিউলের কোহেশন উঁচু (একটা স্পষ্ট উদ্দেশ্য) আর কাপলিং নিচু (একে অপরকে শুধু ছোট ইন্টারফেস দিয়ে ব্যবহার করে); এই ধারণাগুলো ১৯৭৪ সালের "Structured Design" পেপার থেকে।
- সেপারেশন অব কনসার্নস দেখানো, নিয়ম, ডেটা রাখা আর বাইরের সার্ভিসকে আলাদা রাখে; ClinicQueue এটা করে UI, API, লজিক আর ডেটা লেয়ার আর অ্যাডাপ্টার দিয়ে।
- ইন্টারফেস হলো ফরম্যাট, সীমা আর ত্রুটিসহ একটা চুক্তি; প্রত্যাশিত পরিবর্তনের জন্য ডিজাইন করুন, যেমন নতুন SMS প্রোভাইডার বা AI ফিচার বন্ধ করা।
- চেকলিস্ট ধরে আগেভাগে ডিজাইন রিভিউ করুন; KISS, DRY আর YAGNI-কে এমন কাজের নিয়ম হিসেবে দেখুন, যাদের মধ্যে মাঝে মাঝে ভারসাম্য রাখতে হয়।
এরপর: এনটিটি–রিলেশনশিপ ডায়াগ্রাম দিয়ে ডেটা মডেলিং: ClinicQueue-এর ডেটা লেয়ারের ডিজাইন, এর রোগী, ডাক্তার, অ্যাপয়েন্টমেন্ট আর রিমাইন্ডার, আর তাদের মধ্যে সম্পর্ক।

