總覽
本指南提供撰寫 Google Earth Engine 教學課程的一般準則。目標是讓整個 Earth Engine 社群都能輕鬆建立清楚明瞭、簡潔易懂的高品質教學課程。
下方的教學課程範本也可用做額外指南，協助你開始製作自己的教學課程。如要瞭解如何使用範本，請參閱撰寫教學課程。
此外，Google Cloud Platform 社群教學課程樣式指南提供實用參考資料，可協助您為廣大使用者撰寫端對端教學課程，而 Google JavaScript 樣式指南則詳細說明 JavaScript 程式碼範例中建議使用的樣式。審查人員可能會參考這些指南審查您的提交內容。
一般指南
- 簡明扼要。
- 不要重複自己。
- 請勿重複說同樣的內容 (即使措辭不同)。
- 定期標示進度。
- 在教學課程的關鍵時間點加入圖片和文字，讓使用者知道自己是否進展順利。請謹慎使用！
- 盡可能使用主動語態。
- 「使用者變更值時」，而非「值變更時」。
- 例外狀況：如果使用主動語態會造成不便，或行為者顯而易見或不相關 (例如「系統會傳回動畫 GIF」，而非「Earth Engine 會傳回動畫 GIF」)，則可使用被動語態。
- 務必符合事實。
- 避免使用最高級形容詞 (例如「這是100%最佳和最快的方法」)。
- 避免宣傳產品或服務。
- 避免爭議性話題。
- 引用特定方法、資料集和分析時，請附上引文和網址。
- 讓教學課程自成一格。
- 請盡量不要使用 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 筆記本，請按一下這裡：
系統會開啟筆記本，內含撰寫及提交教學課程的操作說明。請務必參閱「撰寫教學課程」，瞭解提案、撰寫和提交程序的重要詳細資料。