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

সংক্ষিপ্ত বিবরণ

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

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

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

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

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

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

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

মার্কডাউন

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

---
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.
-->

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

কোলাব

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

#@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.

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

মার্কডাউন

যদি আপনি গিট এবং গিটহাবের সাথে পরিচিত হন, তবে কাজ শুরু করার জন্য নিচের কোডটি একটি টেমপ্লেট হিসেবে ব্যবহার করতে পারেন:

---
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.

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

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

কোলাব

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

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

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