কমিউনিটি টিউটোরিয়াল স্টাইল গাইড

এক নজরে

এই নির্দেশিকা আপনার নিজের Google Earth Engine টিউটোরিয়াল লেখার জন্য সাধারণ নির্দেশিকা প্রদান করে। এর লক্ষ্য হল খুব ভালো কোয়ালিটির টিউটোরিয়াল তৈরি করা যা স্পষ্ট, সংক্ষিপ্ত এবং সমগ্র Earth Engine কমিউনিটি সহজেই বুঝতে পারে।

নিচে দেওয়া টিউটোরিয়াল টেমপ্লেট আপনার নিজস্ব টিউটোরিয়াল শুরু করতে অতিরিক্ত গাইড হিসেবেও কাজ করে। শুরু করার জন্য টেমপ্লেটগুলি কীভাবে ব্যবহার করবেন তার বিবরণ টিউটোরিয়াল লেখা-তে পাওয়া যাবে।

এছাড়াও, Google Cloud কমিউনিটি টিউটোরিয়াল স্টাইল গাইড অনেক দর্শকের জন্য শুরু থেকে শেষ পর্যন্ত টিউটোরিয়াল লেখার জন্য মূল্যবান রেফারেন্স প্রদান করে, যখন Google JavaScript স্টাইল গাইড JavaScript কোড স্যাম্পেলে ব্যবহার করার জন্য সাজেস্ট করা স্টাইল সম্পর্কে বিস্তারিত তথ্য প্রদান করে। আপনার জমা দেওয়া তথ্য পর্যালোচনা করার সময় রিভিউয়াররা এইসব নির্দেশিকা দেখতে পারেন।

সাধারণ নির্দেশিকা

  • সংক্ষেপে বলো।
  • একই কথা বারবার বলবেন না।
    • একই কথা দুবার বলবেন না (এমনকি অন্যভাবেও নয়)।
  • নির্দিষ্ট সময় অন্তর অগ্রগতি চিহ্নিত করুন।
    • টিউটোরিয়ালের গুরুত্বপূর্ণ পয়েন্টে ছবি ও টেক্সট যোগ করুন যাতে ব্যবহারকারী বুঝতে পারেন যে তিনি সঠিক পথে আছেন। কম ব্যবহার করুন!
  • সম্ভব হলে সবসময় কর্তৃবাচ্য ব্যবহার করুন।
    • "ব্যবহারকারী ভ্যালু পরিবর্তন করলে", "ভ্যালু পরিবর্তন করা হলে" নয়।
    • ব্যতিক্রম: অ্যাক্টিভ ভয়েস ব্যবহার করতে গিয়ে যদি বাক্যটি খুব জটিল হয়ে যায়, অথবা যদি কর্তা স্পষ্ট বা প্রাসঙ্গিক না হয়, তাহলে প্যাসিভ ভয়েস ব্যবহার করা যেতে পারে ("Earth Engine একটি অ্যানিমেটেড GIF রিটার্ন করে" এর পরিবর্তে "একটি অ্যানিমেটেড GIF রিটার্ন করা হয়")।
  • আসল তথ্যের উপর ভিত্তি করে তৈরি করো।
    • সুপারলেটিভ ব্যবহার করবেন না ("এটি হল ১০০% সেরা এবং সবচেয়ে দ্রুত পদ্ধতি")।
    • প্রোডাক্ট বা পরিষেবার প্রচার করা এড়িয়ে চলুন।
    • বিতর্কিত বিষয় এড়িয়ে চলুন।
    • নির্দিষ্ট পদ্ধতি, ডেটাসেট এবং বিশ্লেষণের উল্লেখ করার সময় উদ্ধৃতি এবং URL অন্তর্ভুক্ত করুন।
  • আপনার টিউটোরিয়াল স্বয়ংসম্পূর্ণ করুন।
    • API-এর বাইরে বিশেষ লাইব্রেরি বা পাবলিক Earth Engine ডেটা ক্যাটালগে নেই এমন ডেটাসেটের উপর নির্ভর না করার চেষ্টা করুন।
    • আপনি অতিরিক্ত ডেটা বা অ্যালগরিদম প্রদান করলে, শুধুমাত্র আপনার কাছে অনুমতি থাকলে তবেই সেগুলি শেয়ার করুন। প্রয়োজনীয় সব লাইসেন্স ও অ্যাট্রিবিউশন অন্তর্ভুক্ত করুন।
  • আপনার কোড টেস্ট করুন।
    • আপনার নিবন্ধ পর্যালোচনার জন্য জমা দেওয়ার ঠিক আগে অন্তর্ভুক্ত সমস্ত কোড স্যাম্পেল রান এবং পরীক্ষা করতে ভুলবেন না।

টিউটোরিয়াল ফাইলের হেডার

আপনি যদি টিউটোরিয়াল লেখা বিভাগে দেওয়া টেমপ্লেট ব্যবহার না করে ম্যানুয়ালি কমিউনিটি টিউটোরিয়াল তৈরি ও জমা দেন, তাহলে আপনাকে ফাইলের শুরুতে উপযুক্ত মেটাডেটা ও লাইসেন্স হেডার ম্যানুয়ালি যোগ করতে হবে। আপনার নিজের টিউটোরিয়ালে কপি করা যেতে পারে এমন টেমপ্লেট দেখতে পছন্দসই ফর্ম্যাট বেছে নিন:

মার্কডাউন

ডকুমেন্টের শুরুতে নিম্নলিখিত তথ্য যোগ করুন। হেডারের আগে কোনও হোয়াইটস্পেস বা অন্য অক্ষর থাকা উচিত নয়:

---
title: Your tutorial title
description: A short description of the tutorial, all on one line with no carriage returns.
author: your-github-username
tags: comma-separated, lowercase, list, of, related, keywords
date_published: YYYY-MM-DD
---
<!--
Copyright 2023 The Google Earth Engine Community Authors

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

    https://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
-->

পর্যালোচনার জন্য আপনার টিউটোরিয়াল জমা দেওয়ার আগে উপযুক্ত টেমপ্লেট ফিল্ড পরিবর্তন করতে ভুলবেন না।

Colab

নোটবুকের শুরুতে একটি কোড সেলে নিম্নলিখিতগুলি যোগ করুন:

#@title Copyright 2023 The Earth Engine Community Authors { display-mode: "form" }
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# https://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

টিউটোরিয়াল টেমপ্লেট

মার্কডাউন

আপনি git ও GitHub সম্পর্কে জানলে, কাজ শুরু করার জন্য টেমপ্লেট হিসেবে নিচে দেওয়া কোড ব্যবহার করতে পারেন:

---
title: Your tutorial title
description: A short description of the tutorial, all on one line with no carriage returns.
author: your-github-username
tags: comma-separated, lowercase, list, of, related, keywords
date_published: YYYY-MM-DD
---
<!--
Copyright 2023 The Google Earth Engine Community Authors

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

    https://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
-->

In a few sentences, describe what the user is going to learn. Be sure to include
_concise_ background information; only include what's helpful and relevant.
When in doubt, leave it out!

## Section heading 1

Break up your tutorial into manageable sections.

With one or more paragraphs, separated by a blank line.

Inside your sections, you can also:

1. Use numbered lists
1. ..when the order..
1. ..of items is important.

And:

- This is a bulleted list.
- Use bulleted lists when items are not strictly ordered.

..and even:

Use     | tables   | to organize | content
------- | -------- | ----------- | -------
Your    | tables   | can         | also
contain | multiple | rows        | ...

## Section heading 2

Use separate sections for related, but discrete, groups of steps.

Use code blocks to show users how to do something after describing it:

```js
// Use comments to describe details that can't be easily expressed in code.
// Always try making code more self descriptive before adding a comment.
// Similarly, avoid repeating verbatim what's already said in code
// (e.g., "assign ImageCollection to variable 'coll'").
var coll = ee.ImageCollection('LANDSAT/LC08/C02/T1_TOA');
```

### Use subsections if appropriate

Consider breaking longer sections that cover multiple topics or span multiple
pages into subsections.

অথবা, টিউটোরিয়াল লেখার নির্দেশাবলী অনুসরণ করে GitHub-এর ওয়েব-ভিত্তিক ফাইল এডিটরে সরাসরি উপরের টেমপ্লেটটি খোলা যেতে পারে।

কীভাবে টিউটোরিয়াল প্রস্তাব, রচনা ও জমা দিতে হয় সেই সম্পর্কে গুরুত্বপূর্ণ তথ্য জানতে টিউটোরিয়াল লেখা লিঙ্কটি দেখুন।

Colab

সাজেস্ট করা স্টাইল টেমপ্লেট ব্যবহার করে নতুন Colab নোটবুক তৈরি করতে, এখানে ক্লিক করুন:

নতুন Colab টিউটোরিয়াল

এটি একটি নোটবুক খুলবে যেখানে আপনার টিউটোরিয়াল তৈরি ও জমা দেওয়ার নির্দেশাবলী থাকবে। প্রস্তাব, লেখা ও জমা দেওয়ার প্রসেস সম্পর্কে গুরুত্বপূর্ণ তথ্য জানতে টিউটোরিয়াল লেখা লিঙ্কটি দেখুন।