Übersicht
In dieser Anleitung finden Sie allgemeine Richtlinien zum Schreiben eigener Google Earth Engine-Anleitungen. Ziel ist es, die Erstellung hochwertiger Anleitungen zu erleichtern, 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 die Erstellung eigener Anleitungen zu erleichtern. Details zur Verwendung der Vorlagen finden Sie unter Anleitung schreiben.
Darüber hinaus bietet der Google Cloud Platform 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 sich bei der Überprüfung Ihrer Einreichung auf diese Leitfäden beziehen.
Allgemeine Richtlinien
- Fassen Sie sich kurz.
- Wiederholen Sie sich nicht.
- Sagen Sie nicht zweimal dasselbe (auch wenn es anders formuliert ist).
- Markieren Sie regelmäßig den Fortschritt.
- Fügen Sie an wichtigen Stellen in der Anleitung Bilder und Text ein, damit der Nutzer weiß, dass er auf dem richtigen Weg ist. Verwenden Sie diese Elemente sparsam.
- Verwenden Sie nach Möglichkeit das Aktiv.
- „Wenn der Nutzer den Wert ändert“ statt „Wenn der Wert geändert wird“.
- Ausnahme: Sie können das Passiv verwenden, wenn es zu umständlich wäre, das Aktiv zu verwenden, 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.
- Vermeiden Sie Superlative („Das ist die beste und schnellste Methode“).
- Vermeiden Sie die Werbung für Produkte oder Dienstleistungen.
- Vermeiden Sie kontroverse Themen.
- Fügen Sie Zitate und URLs ein, wenn Sie auf bestimmte Methoden, Datasets und Analysen verweisen.
- Gestalten Sie Ihre Anleitung in sich abgeschlossen.
- Verlassen Sie sich nicht auf spezielle Bibliotheken außerhalb der API oder auf Datasets, die nicht im öffentlichen Earth Engine-Datenkatalog enthalten sind.
- Wenn Sie zusätzliche Daten oder Algorithmen bereitstellen, geben Sie sie nur weiter, wenn Sie dazu berechtigt sind. Fügen Sie alle erforderlichen Lizenzen und Quellenangaben hinzu.
- Testen Sie Ihren Code.
- Führen Sie alle enthaltenen Codebeispiele aus und testen Sie sie, bevor Sie Ihren Artikel zur Überprüfung einreichen.
Datei-Header für Anleitungen
Wenn Sie Community-Anleitungen manuell erstellen und einreichen, ohne die in Anleitung schreiben bereitgestellten Vorlagen zu verwenden, müssen Sie am Anfang der Datei manuell die entsprechenden Metadaten und den Lizenz-Header hinzufügen. Wählen Sie das gewünschte Format aus, um eine Vorlage aufzurufen, die Sie in Ihre eigene Anleitung kopieren können:
Markdown
Fügen Sie Folgendes am Anfang des Dokuments 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 Folgendes in eine Codezelle am Anfang des Notebooks 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, um loszulegen:
---
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.
Unter Anleitung schreiben finden Sie wichtige Details zum Vorschlagen, Erstellen und Einreichen von Anleitungen.
Colab
Wenn Sie ein neues Colab-Notebook mit der empfohlenen Stilvorlage erstellen möchten, klicken Sie hier:
Dadurch wird ein Notebook mit einer Anleitung zum Erstellen und Einreichen Ihrer Anleitung geöffnet. Unter Anleitung schreiben finden Sie wichtige Details zum Vorschlags-, Erstellungs- und Einreichungsprozess.