概要
このガイドでは、独自の Google Earth Engine チュートリアルを作成するための一般的なガイドラインについて説明します。このプロジェクトの目的は、Earth Engine コミュニティ全体が明確かつ簡潔に理解できる高品質なチュートリアルを簡単に作成できるようにすることです。
以下のチュートリアル テンプレートは、独自のチュートリアルを開始するのに役立つ追加のガイドとしても機能します。テンプレートを使用して開始する方法の詳細については、チュートリアルの作成をご覧ください。
また、Google Cloud Platform コミュニティ チュートリアル スタイルガイドは、幅広いユーザーを対象としたエンドツーエンドのチュートリアルを作成するうえで貴重な参考資料となります。一方、Google JavaScript スタイルガイドでは、JavaScript コードサンプルで使用する推奨スタイルについて詳しく説明しています。審査担当者は、提出されたコンテンツを審査する際にこれらのガイドを参照する場合があります。
一般的なガイドライン
- 簡潔に説明します。
- 同じことを繰り返さないでください。
- 同じことを 2 回言わない（言い方が異なっていても）。
- 定期的に進捗状況をマークします。
- チュートリアルの重要なポイントに画像とテキストを含めて、ユーザーが順調に進んでいることを確認できるようにします。使用は控えめに！
- 可能な限り能動態を使用します。
- 「ユーザーが値を変更したとき」であり、「値が変更されたとき」ではありません。
- 例外: 能動態をわざわざ使う必要がない場合や、行為者が明らかな場合、または関係がない場合（「Earth Engine がアニメーション GIF を返す」ではなく「アニメーション GIF が返される」など）は、受動態を使用しても構いません。
- 事実に即して回答してください。
- 最上級の表現（「これは100%最良かつ最速の方法です」など）は避けてください。
- 商品やサービスの宣伝は避けてください。
- 物議を醸しそうなトピックは避ける。
- 特定の方法、データセット、分析を参照する場合は、引用と 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 ノートブックを作成するには、こちらをクリックしてください。
チュートリアルの作成と送信の手順が記載されたノートブックが開きます。提案、作成、送信のプロセスに関する重要な詳細については、チュートリアルの作成を参照してください。