কোনও প্রোগ্রামের উচ্চ-স্তরের আর্কিটেকচারটি নথির জন্য কি কোনও মানদণ্ড রয়েছে?

10

আমি একজন অপেশাদার বিকাশকারী এবং এখন পর্যন্ত আমার সমস্ত প্রোগ্রাম কোডের মধ্যে নথিভুক্ত করার পক্ষে যথেষ্ট সহজ ছিল। কোডটি পড়ার সময় এটি স্পষ্ট হয়েছিল যে আমি কী করছিলাম এবং এ জাতীয় ক্রিয়াটি (আমার স্ট্যান্ডার্ড টেস্টটি ছিল 6 মাস পরে কোডটি দেখানো এবং প্রথমে পড়ার সময় সবকিছু বুঝতে হবে - এবং আমার স্বল্প স্মৃতি স্প্যান রয়েছে)।

আমি এখন এমন একটি প্রোগ্রামের মুখোমুখি হয়েছি যা এর মধ্যে থাকা বিভিন্ন মিথস্ক্রিয়াকে মনে রাখতে আমার সক্ষমতা বাড়িয়ে তুলছে

কোড নিজেই
ডাটাবেসে সূচী
বিভিন্ন মডিউল ("কর্মী" কোর কোড এবং "গ্রন্থাগার" এর মধ্যে) এর মধ্যে মিথস্ক্রিয়া

আমার বর্তমান ডকুমেন্টেশন হ'ল হোয়াইটবোর্ড যেখানে আমার কাছে সমস্ত ধরণের বাক্স এবং তীর রয়েছে যা কোড, ডাটাবেস সূচীগুলিতে, সম্পাদিত ক্রিয়াকলাপ, রাষ্ট্র পরিবর্তনের জন্য নির্দেশ করে Just

আমার প্রশ্নটি আরও জটিল পণ্যগুলির ডকুমেন্টেশনের জন্য একটি আদর্শ, বা নাম দেওয়া সেরা অনুশীলনের সেট (এই নামে অনুভূত হয়েছে যে এটি অনুশীলনের একটি সেট যা একটি নির্দিষ্ট নামের অধীনে দলবদ্ধ করা হয়েছিল) আরও জটিল পণ্যগুলির ডকুমেন্টেশনের জন্য।

আমার কী কীওয়ার্ডগুলি সন্ধান করা উচিত ("ডকুমেন্ট সফ্টওয়্যার আর্কিটেকচার স্ট্যান্ডার্ডগুলিতে সাধারণ প্রচেষ্টা" এবং অনুরূপ প্রকরণগুলি সাধারণত ওয়ার্কফ্লো বা বিল্ডিং আর্কিটেকচার সিএডি সিস্টেমগুলির জন্য সফ্টওয়্যার নিয়ে আসে)।

আমি এও প্রত্যাশা করি যে উচ্চ-স্তরের বর্ণনার জন্য কোনও সাধারণ সেরা অনুশীলন নাও থাকতে পারে এবং প্রত্যেকে তার নিজস্ব দর্শন তৈরি করে।

architecture documentation

— WoJ
সূত্র

উম ইউএমএল এবং কিছু সাধারণ প্লেইন পাঠ্য সাধারণত

— জে কে।

আপনি যদি জার্মান পড়তে পারেন তবে arc42.de/template/index.html দেখুন at তারা সফ্টওয়্যার আর্কিটেকচার ডকুমেন্টিংয়ের জন্য কিছু গাইড লাইন দেখায়।

— বার্নহার্ড হিলার 11

8

"এটি কিছুতেই বিরক্ত করবেন না" সম্ভবত কোনও মানের নিকটতম।

— 16

13

এমন একটি মান নেই যা প্রত্যেকে মেনে চলেন। সফ্টওয়্যার প্রকল্পগুলি বড় আকারে পরিবর্তিত হতে পারে (মনে করুন: স্পেস শাটলের কোড বনাম হেলোরওর্ল্ড.পি)।

একটি খুব সাধারণ পদ্ধতি হ'ল 4 + 1 মডেলটি ব্যবহার করা । ডকুমেন্টের একক শৈলীতে সবকিছু ক্র্যাম করার চেষ্টা করার পরিবর্তে এই পদ্ধতিটি নকশাকে পাঁচটি ভাগে বিভক্ত করে:

উন্নয়ন দৃশ্য
লজিক্যাল দৃশ্য
শারীর দৃশ্য
প্রক্রিয়া দৃশ্য
প্রেক্ষাপটে

বিভিন্ন মতামত চারটি ভিন্ন দৃষ্টিকোণ থেকে পণ্য বর্ণনা করে। পরিস্থিতিগুলি এমন যেখানে ব্যবহারের ক্ষেত্রে বাস করে এবং অন্যান্য মতামতের মিথস্ক্রিয়াকে বর্ণনা করে।

দ্রষ্টব্য: এটি একটি ধারণামূলক মডেল এবং এটি কোনও নির্দিষ্ট সরঞ্জামের সাথে আবদ্ধ নয়।

আপনি এখানে আরও পড়তে পারেন:

4 + 1 আর্কিটেকচারাল ভিউ মডেল (উইকিপিডিয়া)
আর্কিটেকচারাল ব্লুপ্রিন্টস - "4 + 1" সফ্টওয়্যার আর্কিটেকচারের মডেল দেখুন (আইইইই পেপার - পিডিএফ)

— ব্রায়ান ওকলে
সূত্র

ধন্যবাদ এটি একটি খুব ভাল পদ্ধতির। পিছনে পদক্ষেপ নেওয়ার পরে, কেউ ভাবতে পারেন যে এটি বেশ স্পষ্ট, তবে এটি একটি গ্রাফে থাকা আমার কাছে থাকা বিভিন্ন 4 + 1 টুকরোটি সংযোগ বিচ্ছিন্ন করতে অনেক সাহায্য করে।

— ওউজে

4

এই প্রোগ্রামটিতে ইউএমএল হয় না একটি হাতিয়ার যা বাস্তব জগতে সফটওয়্যারের আর্কিটেকচার দলিল জন্য ভাল কাজ করে। শ্রেণীর চিত্রগুলি দরকারী, তবে বিমূর্ততার একটি স্তর ব্যবহার করুন যা প্রায়শই এই উদ্দেশ্যে খুব কম থাকে। কেস ডায়াগ্রাম ব্যবহার করুন সাধারণত খুব "উচ্চ-স্তরের" এবং কিছু দিক মিস করে। অন্যান্য ইউএমএল ডায়াগ্রামের ধরণের ক্ষেত্রেও একই রকম সমস্যা রয়েছে (সুষ্ঠু হতে, প্যাকেজ ডায়াগ্রাম, স্থাপনার চিত্র, উপাদান চিত্রগুলি কিছু স্থাপত্য দিকগুলি নথিভুক্ত করতে পারে তবে ব্যক্তিগতভাবে আমি এগুলিকে কখনই খুব কার্যকর মনে করি নি)।

আপনি যদি উচ্চ-স্তরের আর্কিটেকচার ডকুমেন্ট করার কোনও কার্যকরী, বাস্তববাদী উপায়ের সন্ধান করেন তবে আমি নিজেকে তথ্য প্রবাহের চিত্রগুলির সাথে পরিচিত করার পরামর্শ দিই । এগুলি বোঝা সহজ এবং তারা যে বিমূর্ততা বিভিন্ন স্তরে স্কেল করতে পারে তার সুবিধা রয়েছে। বিভিন্ন ধরণের সিস্টেমে নথির জন্য আমি এগুলিকে সবচেয়ে দরকারী বলে মনে করেছি। খুব খারাপ তারা ইউএমএলে প্রবেশের সন্ধান পায় নি, তবে এই চিত্রগুলি তৈরি করার জন্য আপনি প্রচুর সরঞ্জাম - এমনকি দিয়া বা ড্রইওও -র মতো বিনামূল্যে সরঞ্জামগুলি খুঁজে পান ।

পার্শ্ব নোট হিসাবে, আপনার উচ্চ স্তরের ডকুমেন্টেশনে "ডাটাবেসে ইনডেক্স" কেন লাগবে ? আমি মনে করি এগুলি আপনার (সম্পর্কিত?) ডেটা মডেলের একটি বাস্তবায়নের বিশদ এবং আপনি যদি এগুলি যোগ করেন বা না করেন তবে - আমার অভিজ্ঞতার ক্ষেত্রে - আরও কার্যকারিতা এবং অপ্টিমাইজেশনের প্রশ্ন।

— ডক ব্রাউন
সূত্র

প্যাকেজ চিত্র? স্থাপনার চিত্র? কম্পোনেন্ট ডায়াগ্রাম?

— নিক কেঘলি

3

সত্যই তীরগুলি সহ গুচ্ছের একটি গোছা বেশ কয়েকটি ডিজাইন বৈশিষ্ট্য যোগাযোগের জন্য আশ্চর্য কাজ করতে পারে। আমি অনুমান করি উপাদান উপাদানটি সেই বিভাগে পড়ে তবে আমার ক্লায়েন্টরা মূল বিটগুলির প্রতিনিধিত্বকারী বাক্সগুলির সাথে ডেটা ফ্লো বুঝতে পারে। আমি ডক ব্রাউন এর সাথে একমত ইউএমএলের আনুষ্ঠানিকতা তার উদ্দেশ্যযুক্ত উদ্দেশ্যটির সাথে চিহ্নটি মিস করে।

— বেরিন লরিশচ

@ নিককিগলি: আমার সম্পাদনা দেখুন।

— ডক ব্রাউন

@ বেরিনলরিটস: আইএমএইচও "তীরযুক্ত একগুচ্ছ বাক্স" নিক কেইগলি দ্বারা উল্লিখিত চিত্রের বৈশিষ্ট্যগুলি চিহ্নিত করেছেন। ডেটা ফ্লো ডায়াগ্রামগুলি অবশ্য ডেটা বা গোষ্ঠী / উপাত্তের ক্লাস্টার এবং প্রক্রিয়া বা উপাদানগুলির মধ্যে একটি স্পষ্ট আনুষ্ঠানিক পার্থক্য তৈরি করে যা এই ডেটা স্থানান্তর বা রূপান্তর করে। এটি কোনও ইউএমএল ডায়াগ্রামের সাথে সহজেই প্রকাশ করতে পারি না।

— ডক ব্রাউন 14

1

আমাকে স্বীকার করতে হবে আমি মাঝে মাঝে ডেটা ফ্লো ডায়াগ্রামগুলি অবলম্বন করি - বিশেষত যেগুলি স্টোরকে অনুমতি দেয়। আসলে আমাদের সিস্টেমে বর্ণিত শীর্ষ স্তরের চিত্রটি মূলত একটি ডিএফডি। আমি এখনও ক্লাস ডায়াগ্রাম এবং প্যাকেজটিকে কিছুটা কার্যকর বলে মনে করি। আমি ইউএমএলের "ফর্মাল" অংশগুলিতে খুব একটা মনোযোগ দিচ্ছি না।

— নিক কেঘলি

0

ইউনিফাইড মডেলিং ল্যাঙ্গুয়েজ (ইউএমএল) হল একটি সফটওয়্যার ইঞ্জিনিয়ারিংয়ের ক্ষেত্রে একটি সাধারণ-উদ্দেশ্য, উন্নয়নমূলক, মডেলিং ল্যাঙ্গুয়েজ, এটি একটি সিস্টেমের নকশাকে দৃশ্যমান করার জন্য একটি স্ট্যান্ডার্ড উপায় সরবরাহ করার উদ্দেশ্যে is

আনুষ্ঠানিক স্পেসিফিকেশনটি omg.org/spec/UML/2.5 এ পাওয়া যাবে তবে ওয়েবে প্রচুর বন্ধুত্বপূর্ণ টিউটোরিয়াল রয়েছে।

— সাইমন বি

2

এটি প্রশ্নের কেবল একটি অংশের উত্তর দেয়, ইউএমএল মডেলাইজ করার জন্য সঠিকভাবে সঠিক সরঞ্জাম, তবে এটি নিজেই একটি সম্পূর্ণ ডকুমেন্টেশন গঠন করে না

— ওয়ালফ্র্যাট

3

কেউ কি খুব বেশি সময় ইউএমএল ব্যবহার করে?

— Panzercrisis

doodling। বিপরীত প্রকৌশল।

— নিক কেইগলি

1

@Walfrat। তাই কি? সত্যি? আমার সন্দেহ আছে

— ডক ব্রাউন

-3

আমি মনে করি আমরা আরও ভাল করতাম। ইউএমএল মনে হয়েছিল স্নানের জল দিয়ে বাচ্চাকে বাইরে ফেলে দিয়েছে। ইউনিফাইড মডেলিং ল্যাঙ্গুয়েজ সরবরাহ করার ক্ষেত্রে এটি আর্কিটেকচার এবং বাস্তবায়নের মধ্যে পার্থক্যকে বিলোপ করে। বা এটি এর উদ্দেশ্য না থাকলে এটি কার্যকর হবে বলে মনে হয়।

আমি কিছু দানব ইউএমএল মডেল দেখেছি এবং সত্যই তারা আমার জন্য কোডটি করতে পারে না এমন কিছু করে না এবং আরও ভাল করে।

— নিক কেইগলি
সূত্র

3

প্রশ্নের উত্তর দেয় না, সুপারগার্লের উত্তরের মন্তব্য হিসাবে সম্ভবত এটি আরও ভাল।

— নিউটোপিয়ান

1

এটি প্রশ্ন সম্বোধন করে। আমি যুক্তি দিচ্ছি যে প্রশ্নের উত্তর আগে যেভাবে দেওয়া হয়েছিল তার চেয়ে বেশি "না"।

— নিক কেঘলি