Présentation
Ce guide fournit des consignes générales pour rédiger vos propres tutoriels Google Earth Engine. Il vise à faciliter la création de tutoriels de haute qualité, clairs, concis et facilement compréhensibles par l'ensemble de la communauté Earth Engine.
Les modèles de tutoriels ci-dessous servent également de guide supplémentaire pour vous aider à créer vos propres tutoriels. Pour savoir comment utiliser les modèles pour vous lancer, consultez Rédiger un tutoriel.
De plus, le Guide de style des tutoriels de la communauté Google Cloud Platform constitue une référence précieuse pour la rédaction de tutoriels de bout en bout destinés à un large public, tandis que le Guide de style JavaScript de Google détaille le style recommandé pour les exemples de code JavaScript. Les examinateurs peuvent se référer à ces guides lorsqu'ils examinent votre envoi.
Consignes générales
- Soyez bref.
- Ne vous répétez pas.
- Ne répétez pas la même chose (même si vous la formulez différemment).
- Marquez régulièrement votre progression.
- Incluez des images et du texte à des points clés du tutoriel pour que l'utilisateur sache qu'il est sur la bonne voie. À utiliser avec parcimonie !
- Utilisez la voix active dans la mesure du possible.
- "Lorsque l'utilisateur modifie la valeur", et non "lorsque la valeur est modifiée".
- Exception : Il est acceptable d'utiliser la voix passive lorsque vous devez faire des efforts pour utiliser la voix active, ou si l'acteur est évident ou non pertinent ("un GIF animé est renvoyé" au lieu de "Earth Engine renvoie un GIF animé").
- Tenez-vous-en aux faits.
- Évitez les superlatifs ("c'est la méthode 100% meilleure et la plus rapide").
- Évitez de promouvoir des produits ou des services.
- Évitez les sujets controversés.
- Incluez des citations et des URL lorsque vous faites référence à des méthodes, des ensembles de données et des analyses spécifiques.
- Rendez votre tutoriel autonome.
- Essayez de ne pas vous appuyer sur des bibliothèques spéciales en dehors de l'API ni sur des ensembles de données qui ne figurent pas dans le catalogue de données Earth Engine public.
- Si vous fournissez des données ou des algorithmes supplémentaires, ne les partagez que si vous y êtes autorisé. Incluez toutes les licences et attributions requises.
- Testez votre code.
- Veillez à exécuter et à tester tous les exemples de code inclus juste avant d'envoyer votre article pour examen.
En-têtes des fichiers du tutoriel
Si vous créez et envoyez manuellement des tutoriels de la communauté sans utiliser les modèles fournis dans Rédiger un tutoriel, vous devrez ajouter manuellement les métadonnées et l'en-tête de licence appropriés au début du fichier. Sélectionnez le format souhaité pour afficher un modèle qui peut être copié dans votre propre tutoriel :
Markdown
Ajoutez les lignes suivantes au début du document. Aucun espace ni aucun autre caractère ne doivent précéder l'en-tête :
---
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.
-->
Veillez à remplacer les champs appropriés du modèle avant d'envoyer votre tutoriel pour examen.
Colab
Ajoutez le code suivant à une cellule de code au début du notebook :
#@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.
Modèles de tutoriels
Markdown
Si vous connaissez git et GitHub, vous pouvez utiliser le code ci-dessous comme modèle pour commencer :
---
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.
Vous pouvez également ouvrir le modèle ci-dessus directement dans l'éditeur de fichiers Web de GitHub en suivant les instructions de la section Écrire un tutoriel.
Pour obtenir des informations importantes sur la façon de proposer, de rédiger et d'envoyer des tutoriels, consultez Rédiger un tutoriel.
Colab
Pour créer un notebook Colab à l'aide du modèle de style recommandé, cliquez ici :
Un notebook contenant des instructions pour créer et envoyer votre tutoriel s'ouvre. Veillez à consulter Rédiger un tutoriel pour obtenir des informations importantes sur le processus de proposition, de création et d'envoi.