নোটিশ (কলআউট, নোট, সতর্কতা, ইত্যাদি)

DevSite বিভিন্ন পটভূমির রঙ সহ বাক্স হিসাবে উপস্থাপিত বিভিন্ন নোটিশ শৈলী সমর্থন করে। পটভূমির রং পূর্বনির্ধারিত, এবং আপনি HTML বা Markdown ব্যবহার করে নোটিশ তৈরি করতে পারেন।

উপলব্ধ বিজ্ঞপ্তি প্রকার

দ্রষ্টব্য

<aside class="note">
<b>Note:</b> An ordinary note.
</aside>

Note: An ordinary note.

টিপ

<aside class="tip">
<b>Tip:</b> An ordinary tip.
</aside>

Tip: An ordinary tip.

সতর্কতা

<aside class="caution">
<b>Caution:</b> Suggests proceeding with caution.
</aside>

Caution: Suggests proceeding with caution.

সতর্কতা

<aside class="warning">
<b>Warning:</b> Stronger than caution; it means "Don't do this."
</aside>

Warning: Stronger than caution; it means "Don't do this."

গুরুত্বপূর্ণ

<aside class="special">
<b>Important:</b> Defines an important concept.
</aside>

Important: Defines an important concept.

কী পয়েন্ট

<aside class="key-point">
<b>Key Point:</b> Defines an important takeaway.
</aside>

Key Point: Defines an important takeaway.

মূল মেয়াদ

<aside class="key-term">
<b>Key Term:</b> Defines important terminology.
</aside>

Key Term: Defines important terminology.

উদ্দেশ্য

<aside class="objective">
<b>Objective:</b> Defines the goal of a procedure.
</aside>

Objective: Defines the goal of a procedure.

সফলতা

<aside class="success">
<b>Success:</b> Describes a successful action or an error-free status.
Used only in interactive or dynamic content; don't use in ordinary
static pages.
</aside>

Success: Describes a successful action or an error-free status. Used only
in interactive or dynamic content; don't use in ordinary static pages.

বেটা

<aside class="beta">
<b>Beta:</b> A notice that describes a beta-release feature, which is
subject to change or removal in new minor versions of the product.
</aside>

Beta: A notice that describes a beta-release feature, which is subject to
change or removal in new minor versions of the product.

পূর্বরূপ

<aside class="preview">
<b>Preview:</b> A note or tip for a feature preview.
</aside>

Preview: A note or tip for a feature preview.

ডগফুড

<aside class="dogfood">
<b>Dogfood:</b> A notice that applies only temporarily, during internal
dogfood testing. Remove all Dogfood notices before making a document
publicly visible.
</aside>

Dogfood: A notice that applies only temporarily, during internal dogfood
testing. Remove all Dogfood notices before making a document publicly
visible.

অবচয়

<aside class="deprecated">
<b>Deprecated:</b> A note or tip for a deprecated feature, product, or
service.
</aside>

Deprecated: A note or tip for a deprecated feature, product, or service.

ব্যবহারের নোট

এইচটিএমএল ব্যবহার

আমরা HTML5 <aside> উপাদানের সাথে এই ক্লাসগুলি ব্যবহার করার পরামর্শ দিই, তবে আপনি পরিবর্তে অন্য ব্লক-লেভেল উপাদান (যেমন <p> ) ব্যবহার করতে পারেন।

HTML ক্লাসগুলি নোটিশের রঙ এবং আইকন নির্ধারণ করে, কিন্তু তারা স্বয়ংক্রিয়ভাবে বোল্ড করা প্রথম শব্দ সেট করে না; আপনাকে সেই শব্দটি ম্যানুয়ালি লিখতে হবে, যেমন উদাহরণে দেখানো হয়েছে। আপনি তাত্ত্বিকভাবে ক্লাসের সাথে সম্পর্কিত শব্দ ব্যতীত অন্য একটি শব্দ ব্যবহার করতে পারেন, তবে আমরা সুপারিশ করি যে আপনি উপরে দেখানো প্রথম শব্দগুলির সাথে লেগে থাকুন।

পুরানো নথিতে, আপনি class="note" এর পরিবর্তে class="special" বা nonstandard ক্লাসের নাম দেখতে পারেন। এই শ্রেণীর নামগুলি নোটিশগুলি তৈরি করে যা একটি note নোটিশের সাথে দৃশ্যত অভিন্ন, তবে আমরা বিশেষ বা অ-মানক শ্রেণীর নামের পরিবর্তে class="note" ব্যবহার করার পরামর্শ দিই।

মার্কডাউন ব্যবহার

মার্কডাউন শৈলীগুলি নোটিশের রঙ এবং আইকন নির্ধারণ করে এবং তারা স্বয়ংক্রিয়ভাবে নোটিশের বোল্ড করা প্রথম শব্দ সেট করে। সুতরাং, উদাহরণস্বরূপ, মার্কডাউনে একটি নোট সর্বদা Note: বোল্ড শব্দ দিয়ে শুরু হয়।

একাধিক অনুচ্ছেদের নোটিশের জন্য, পরিবর্তে HTML <aside> (এবং <p> ) ব্যবহার করুন।

আপনি Note: এর পরিবর্তে Important: দেখতে পারেন। সেই মার্কডাউন শৈলীটি নোটিশ তৈরি করে যা একটি Note: নোটিশের সাথে দৃশ্যত অভিন্ন।

সর্বোত্তম অনুশীলন

আপনার ডকুমেন্টেশনে বিজ্ঞপ্তি যোগ করার সময় DevSite আপনাকে নিম্নলিখিত সেরা অনুশীলনগুলি মেনে চলার পরামর্শ দেয়:

প্রস্তাবিত

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

প্রস্তাবিত নয়

• নোটিশে কোড উদাহরণ, টেবিল বা ছবি অন্তর্ভুক্ত করবেন না।
• একে অপরের উপরে নোটিশ স্ট্যাক করা এড়িয়ে চলুন, এমনকি যদি সেগুলি বিভিন্ন ধরনের হয়।
• শিরোনাম পরে অবিলম্বে বিজ্ঞপ্তি সন্নিবেশ না করার চেষ্টা করুন.
• একটি পদ্ধতির আগে পূর্বশর্ত নির্দিষ্ট করার জন্য নোটিশ ব্যবহার করবেন না।

বেশিরভাগ ক্ষেত্রে, এই সর্বোত্তম অনুশীলনগুলি note , caution , এবং warning নোটিশের ক্ষেত্রে প্রযোজ্য , কিন্তু অন্যান্য প্রকারের ক্ষেত্রে প্রযোজ্য হতে পারে৷

ভালো উদাহরণ

এটা সহজ রাখুন:

ডেটার সম্ভাব্য ক্ষতির জন্য cautions অবলম্বন করুন:

সম্ভাব্য আঘাতের জন্য warning ব্যবহার করুন:

বিষয়বস্তুর জন্য উপযুক্ত নোটিশের ধরন ব্যবহার করুন, যেমন key-term বা success :

খারাপ উদাহরণ

নোটিশগুলি অত্যধিক শব্দযুক্ত হওয়া উচিত নয় বা মূল বিষয়বস্তুর অন্তর্গত তথ্য প্রকাশ করা উচিত নয়:

বিজ্ঞপ্তিতে একটি পদ্ধতির আগে পূর্বশর্তগুলি নির্দিষ্ট করা উচিত নয় (পরিবর্তে একটি "পূর্বশর্ত" বিভাগ ব্যবহার করুন):