Übersicht
In diesem Leitfaden finden Sie allgemeine Richtlinien zum Schreiben eigener Google Earth Engine-Anleitungen. Ziel ist es, die Erstellung hochwertiger Tutorials zu vereinfachen, die klar, prägnant und für die gesamte Earth Engine-Community leicht verständlich sind.
Die folgenden Anleitungsvorlagen dienen auch als zusätzliche Anleitung, um Ihnen den Einstieg in Ihre eigenen Anleitungen zu erleichtern. Details zur Verwendung der Vorlagen für den Einstieg finden Sie unter Anleitung schreiben.
Darüber hinaus bietet der Google Cloud Community Tutorial Style Guide eine wertvolle Referenz für das Schreiben von End-to-End-Anleitungen für ein breites Publikum, während der Google JavaScript Style Guide den empfohlenen Stil für die Verwendung in JavaScript-Codebeispielen beschreibt. Prüfer können diese Leitfäden bei der Überprüfung Ihrer Einreichung heranziehen.
Allgemeine Richtlinien
- Fassen Sie sich kurz.
- Wiederholen Sie sich nicht.
- Sagen Sie nicht zweimal dasselbe (auch wenn Sie es anders formulieren).
- Fortschritte regelmäßig markieren
- Fügen Sie an wichtigen Stellen in der Anleitung Bilder und Text ein, damit der Nutzer weiß, dass er auf dem richtigen Weg ist. Mit Bedacht verwenden.
- Verwenden Sie nach Möglichkeit die Aktivform.
- „Wenn der Nutzer den Wert ändert“, nicht „wenn der Wert geändert wird“.
- Ausnahme: Es ist in Ordnung, die Passivform zu verwenden, wenn die Aktivform zu umständlich wäre oder wenn der Akteur offensichtlich oder nicht relevant ist („ein animiertes GIF wird zurückgegeben“ statt „Earth Engine gibt ein animiertes GIF zurück“).
- Halten Sie sich an die Fakten.
- Vermeide Superlative („Das ist zu 100% die beste und schnellste Methode“).
- Vermeiden Sie es, Produkte oder Dienstleistungen zu bewerben.
- Vermeiden Sie kontroverse Themen.
- Geben Sie Zitate und URLs an, wenn Sie auf bestimmte Methoden, Datasets und Analysen verweisen.
- Achten Sie darauf, dass Ihre Anleitung eigenständig ist.
- Versuchen Sie, sich nicht auf spezielle Bibliotheken außerhalb der API oder auf Datasets zu verlassen, die nicht im öffentlichen Earth Engine Data Catalog enthalten sind.
- Wenn Sie zusätzliche Daten oder Algorithmen bereitstellen, geben Sie diese nur weiter, wenn Sie dazu berechtigt sind. Fügen Sie alle erforderlichen Lizenzen und Quellenangaben hinzu.
- Testen Sie den Code.
- Führen Sie alle enthaltenen Codebeispiele aus und testen Sie sie, bevor Sie Ihren Artikel zur Überprüfung einreichen.
Header der Anleitungsdatei
Wenn Sie Community-Anleitungen manuell erstellen und einreichen, ohne die unter Anleitung schreiben bereitgestellten Vorlagen zu verwenden, müssen Sie die entsprechenden Metadaten und den Lizenzheader manuell am Anfang der Datei hinzufügen. Wählen Sie das gewünschte Format aus, um eine Vorlage aufzurufen, die Sie in Ihr eigenes Tutorial kopieren können:
Markdown
Fügen Sie am Anfang des Dokuments Folgendes hinzu: Vor dem Header dürfen keine Leerzeichen oder andere Zeichen stehen:
---
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.
-->
Ersetzen Sie die entsprechenden Vorlagenfelder, bevor Sie Ihre Anleitung zur Überprüfung einreichen.
Colab
Fügen Sie am Anfang des Notebooks den folgenden Code in eine Codezelle ein:
#@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.
Anleitungsvorlagen
Markdown
Wenn Sie mit Git und GitHub vertraut sind, können Sie den folgenden Code als Vorlage verwenden:
---
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.
Alternativ kann die obige Vorlage direkt im webbasierten Dateieditor von GitHub geöffnet werden. Folgen Sie dazu der Anleitung unter Anleitung schreiben.
Wichtige Informationen zum Vorschlagen, Verfassen und Einreichen von Anleitungen finden Sie unter Anleitung schreiben.
Colab
Klicken Sie hier, um ein neues Colab-Notebook mit der empfohlenen Stilvorlage zu erstellen:
Dadurch wird ein Notebook mit einer Anleitung zum Erstellen und Einreichen Ihrer Anleitung geöffnet. Wichtige Details zum Vorschlags-, Erstellungs- und Einreichungsprozess finden Sie unter Anleitung schreiben.