Genel Bakış
Bu kılavuzda, kendi Google Earth Engine eğitimlerinizi yazmayla ilgili genel yönergeler verilmektedir. Bu proje, Earth Engine topluluğunun tamamı tarafından kolayca anlaşılabilen, net ve kısa, yüksek kaliteli eğitimler oluşturmayı kolaylaştırmayı amaçlar.
Aşağıdaki eğitim şablonları, kendi eğitimlerinizi başlatmanıza yardımcı olacak ek bir kılavuz olarak da kullanılabilir. Başlamak için şablonları nasıl kullanacağınızla ilgili ayrıntıları Eğitici Yazma bölümünde bulabilirsiniz.
Ayrıca, Google Cloud Platform Topluluğu Eğitim Stili Kılavuzu, geniş bir kitleye yönelik uçtan uca eğitimler yazmak için değerli bir referans sunarken Google JavaScript Stili Kılavuzu, JavaScript kodu örneklerinde kullanılması önerilen stili ayrıntılı olarak açıklar. İnceleme uzmanları, gönderiminizi incelerken bu kılavuzlardan yararlanabilir.
Genel yönergeler
- Kısa ve öz olun.
- Kendinizi tekrarlamayın.
- Aynı şeyi iki kez söylemeyin (farklı şekilde ifade etseniz bile).
- İlerleme durumunu düzenli olarak işaretleyin.
- Eğitimin önemli noktalarına resim ve metin ekleyerek kullanıcının doğru yolda olduğunu anlamasını sağlayın. Bu özelliği dikkatli kullanın.
- Mümkün olduğunda etken çatı kullanın.
- "Kullanıcı değeri değiştirdiğinde" değil, "değer değiştirildiğinde".
- İstisna: Etken yapı kullanmak için çok çaba harcamanız gerekiyorsa veya özne açıkça belli ya da alakalı değilse (ör. "Earth Engine, animasyonlu GIF döndürüyor" yerine "Animasyonlu GIF döndürülüyor") edilgen yapı kullanabilirsiniz.
- Gerçeklere bağlı kalın.
- En üstünlük derecesi içeren ifadelerden ("Bu, %100 en iyi ve en hızlı yöntemdir") kaçının.
- Ürün veya hizmet tanıtımından kaçının.
- Tartışmalı konulardan kaçının.
- Belirli yöntemlere, veri kümelerine ve analizlere referans verirken alıntıları ve URL'leri ekleyin.
- Eğitiminizi bağımsız hale getirin.
- API dışındaki özel kitaplıklara veya herkese açık Earth Engine Data Catalog'da bulunmayan veri kümelerine güvenmemeye çalışın.
- Ek veriler veya algoritmalar sağlıyorsanız bunları yalnızca paylaşma izniniz varsa paylaşın. Gerekli tüm lisansları ve atıfları ekleyin.
- Kodunuzu test edin.
- Makalenizi incelemeye göndermeden hemen önce tüm kod örneklerini çalıştırıp test ettiğinizden emin olun.
Eğitim dosyası üstbilgileri
Eğitim Yazma bölümünde sağlanan şablonları kullanmadan topluluk eğitimlerini manuel olarak oluşturup gönderiyorsanız dosyanın başına uygun meta verileri ve lisans başlığını manuel olarak eklemeniz gerekir. Kendi eğitiminize kopyalanabilecek bir şablonu görüntülemek için istediğiniz biçimi seçin:
Markdown
Aşağıdakileri belgenin başına ekleyin. Başlıktan önce boşluk veya başka karakterler olmamalıdır:
---
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.
-->
Eğitiminizi incelemeye göndermeden önce uygun şablon alanlarını değiştirdiğinizden emin olun.
Colab
Aşağıdakileri not defterinin başındaki bir kod hücresine ekleyin:
#@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.
Eğitim şablonları
Markdown
Git ve GitHub hakkında bilginiz varsa başlamak için aşağıdaki kodu şablon olarak kullanabilirsiniz:
---
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.
Alternatif olarak, yukarıdaki şablon Eğitim Yazma bölümündeki talimatlar uygulanarak doğrudan GitHub'ın web tabanlı dosya düzenleyicisinde açılabilir.
Eğitim önerisinde bulunma, eğitim yazma ve gönderme ile ilgili önemli ayrıntılar için Eğitim Yazma başlıklı makaleyi inceleyin.
Colab
Önerilen stil şablonunu kullanarak yeni bir Colab not defteri oluşturmak için burayı tıklayın:
Bu işlemle, eğitiminizi oluşturma ve göndermeyle ilgili talimatları içeren bir not defteri açılır. Teklif, içerik oluşturma ve gönderme süreciyle ilgili önemli ayrıntılar için Eğitici İçerik Yazma başlıklı makaleyi inceleyin.