نمای کلی
این راهنما دستورالعملهای کلی برای نوشتن آموزشهای Google Earth Engine خودتان ارائه میدهد. هدف آن آسان کردن ایجاد آموزشهای با کیفیت بالا، واضح، مختصر و قابل فهم برای کل جامعه Earth Engine است.
قالبهای آموزشی زیر به عنوان یک راهنمای اضافی برای کمک به شروع آموزشهای شما عمل میکنند. جزئیات مربوط به نحوه استفاده از قالبها برای شروع را میتوانید در بخش «نوشتن یک آموزش» بیابید.
علاوه بر این، راهنمای سبک آموزش انجمن پلتفرم ابری گوگل، مرجع ارزشمندی برای نوشتن آموزشهای جامع برای طیف وسیعی از مخاطبان ارائه میدهد، در حالی که راهنمای سبک جاوا اسکریپت گوگل، سبک پیشنهادی برای استفاده در نمونههای کد جاوا اسکریپت را شرح میدهد. داوران میتوانند هنگام بررسی ارسال شما به این راهنماها مراجعه کنند.
دستورالعملهای کلی
- مختصر باشید.
- خودت را تکرار نکن.
- یک حرف را دو بار تکرار نکنید (حتی اگر با کلمات متفاوتی بیان شده باشد).
- به صورت دورهای پیشرفت را علامتگذاری کنید.
- تصاویر و متن را در نکات کلیدی آموزش قرار دهید تا کاربر بداند که در مسیر درست قرار دارد. در استفاده از آنها صرفهجویی کنید!
- هر زمان که ممکن بود از صدای فعال استفاده کنید.
- «وقتی کاربر مقدار را تغییر میدهد»، نه «وقتی مقدار تغییر میکند».
- استثنا: استفاده از ساختار مجهول زمانی که مجبور باشید از ساختار معلوم استفاده کنید، یا اگر بازیگر مشخص یا بیربط باشد (مثلاً «یک GIF متحرک برگردانده میشود» به جای «موتور زمین یک GIF متحرک برمیگرداند») اشکالی ندارد.
- به حقایق پایبند باشید.
- از صفات عالی (مثلاً «این ۱۰۰٪ بهترین و سریعترین روش است») پرهیز کنید.
- از تبلیغ محصولات یا خدمات خودداری کنید.
- از مباحث جنجالی پرهیز کنید.
- هنگام ارجاع به روشها، مجموعه دادهها و تحلیلهای خاص، استنادها و نشانیهای اینترنتی (URL) را نیز لحاظ کنید.
- آموزش خود را مستقل و جامع کنید.
- سعی کنید به کتابخانههای ویژه خارج از API یا مجموعه دادههایی که در کاتالوگ عمومی دادههای موتور زمین (Earth Engine Data Catalog) نیستند، تکیه نکنید.
- اگر دادهها یا الگوریتمهای اضافی ارائه میدهید، فقط در صورتی آنها را به اشتراک بگذارید که اجازه انجام این کار را داشته باشید. تمام مجوزها و اسناد مورد نیاز را ذکر کنید.
- کد خود را آزمایش کنید.
- حتماً قبل از ارسال مقاله خود برای بررسی، تمام نمونههای کد موجود را اجرا و آزمایش کنید.
سربرگ فایلهای آموزشی
اگر آموزشهای انجمن را به صورت دستی و بدون استفاده از الگوهای ارائه شده در «نوشتن یک آموزش» ایجاد و ارسال میکنید، باید فراداده و سربرگ مجوز مناسب را به صورت دستی به ابتدای فایل اضافه کنید. قالب مورد نظر را برای مشاهده الگویی که میتواند در آموزش شما کپی شود، انتخاب کنید:
نشانهگذاری
عبارت زیر را به ابتدای سند اضافه کنید. هیچ فاصله یا کاراکتر دیگری نباید قبل از سربرگ قرار گیرد:
---
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.
از طرف دیگر، الگوی فوق را میتوان مستقیماً در ویرایشگر فایل مبتنی بر وب GitHub با دنبال کردن دستورالعملهای موجود در بخش «نوشتن یک آموزش» باز کرد.
برای جزئیات مهم در مورد نحوه پیشنهاد، تألیف و ارسال آموزشها، حتماً به بخش «نوشتن آموزش» مراجعه کنید.
کولاب
برای ایجاد یک دفترچه یادداشت جدید Colab با استفاده از الگوی سبک پیشنهادی، اینجا کلیک کنید:
این کار یک دفترچه یادداشت حاوی دستورالعملهای نگارش و ارسال آموزش شما را باز میکند. برای جزئیات مهم در مورد پروپوزال، نگارش و فرآیند ارسال، حتماً به بخش «نوشتن آموزش» مراجعه کنید.