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