Panduan Gaya Tutorial Komunitas

Ringkasan

Panduan ini memberikan panduan umum untuk menulis tutorial Google Earth Engine Anda sendiri. Tujuannya adalah untuk memudahkan pembuatan tutorial berkualitas tinggi yang jelas, ringkas, dan mudah dipahami oleh seluruh komunitas Earth Engine.

Template tutorial di bawah juga berfungsi sebagai panduan tambahan untuk membantu memulai tutorial Anda sendiri. Detail tentang cara menggunakan template untuk memulai dapat ditemukan di Menulis Tutorial.

Selain itu, Panduan Gaya Tutorial Komunitas Google Cloud Platform memberikan referensi berharga untuk menulis tutorial menyeluruh bagi audiens yang luas, sedangkan Panduan Gaya JavaScript Google menjelaskan gaya yang direkomendasikan untuk digunakan dalam contoh kode JavaScript. Peninjau dapat merujuk panduan ini saat meninjau pengiriman Anda.

Panduan umum

  • Singkat.
  • Jangan mengulang-ulang.
    • Jangan mengatakan hal yang sama dua kali (meskipun dirumuskan secara berbeda).
  • Tandai progres secara berkala.
    • Sertakan gambar dan teks pada poin-poin penting dalam tutorial agar pengguna tahu bahwa mereka berada di jalur yang benar. Gunakan seperlunya.
  • Gunakan kalimat aktif jika memungkinkan.
    • "Saat pengguna mengubah nilai", bukan "saat nilai diubah".
    • Pengecualian: Anda dapat menggunakan kalimat pasif jika harus menggunakan kalimat aktif, atau jika aktornya jelas atau tidak relevan ("GIF animasi ditampilkan" dan bukan "Earth Engine menampilkan GIF animasi").
  • Berikan fakta.
    • Hindari kata-kata superlatif ("ini adalah metode terbaik dan tercepat 100%").
    • Hindari mempromosikan produk atau layanan.
    • Hindari topik kontroversial.
    • Sertakan kutipan dan URL saat mereferensikan metode, set data, dan analisis tertentu.
  • Buat tutorial Anda mandiri.
    • Jangan mengandalkan library khusus di luar API atau set data yang tidak ada di publik Katalog Data Earth Engine.
    • Jika Anda memberikan data atau algoritma tambahan, bagikan hanya jika Anda memiliki izin untuk melakukannya. Sertakan semua lisensi dan atribusi yang diperlukan.
  • Uji kode Anda.
    • Pastikan untuk menjalankan dan menguji semua contoh kode yang disertakan tepat sebelum mengirimkan artikel Anda untuk ditinjau.

Header file tutorial

Jika Anda membuat dan mengirimkan tutorial komunitas secara manual tanpa menggunakan template yang disediakan di Menulis Tutorial, Anda harus menambahkan header metadata dan lisensi yang sesuai secara manual ke awal file. Pilih format yang diinginkan untuk melihat template yang dapat disalin ke tutorial Anda sendiri:

Markdown

Tambahkan hal berikut ke awal dokumen. Tidak boleh ada spasi kosong atau karakter lain sebelum header:

---
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.
-->

Pastikan untuk mengganti kolom template yang sesuai sebelum mengirimkan tutorial Anda untuk ditinjau.

Colab

Tambahkan hal berikut ke sel kode di awal 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.

Template tutorial

Markdown

Jika Anda memahami git dan GitHub, Anda dapat menggunakan kode di bawah sebagai template untuk memulai:

---
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.

Atau, template di atas dapat dibuka langsung di editor file berbasis web GitHub's dengan mengikuti petunjuk di Menulis Tutorial.

Pastikan untuk merujuk ke Menulis Tutorial untuk mengetahui detail penting tentang cara mengusulkan, menulis, dan mengirimkan tutorial.

Colab

Untuk membuat notebook Colab baru menggunakan template gaya yang direkomendasikan, klik di sini:

Tutorial Colab baru

Tindakan ini akan membuka notebook yang berisi petunjuk untuk menulis dan mengirimkan tutorial Anda. Pastikan untuk merujuk ke Menulis Tutorial untuk mengetahui detail penting tentang proses proposal, penulisan, dan pengiriman.