ภาพรวม
คำแนะนำนี้มีหลักเกณฑ์ทั่วไปสำหรับการเขียนบทแนะนำ Google Earth Engine ของคุณเอง โดยมีเป้าหมายที่จะช่วยให้การสร้างบทแนะนำคุณภาพสูงเป็นเรื่องง่าย ซึ่งบทแนะนำเหล่านี้จะต้อง ชัดเจน กระชับ และชุมชน Earth Engine ทั้งหมดเข้าใจได้ง่าย
เทมเพลตบทแนะนำด้านล่างนี้ยังเป็น คู่มือเพิ่มเติมที่จะช่วยให้คุณเริ่มต้นสร้างบทแนะนำของคุณเองได้ ดูรายละเอียดวิธีใช้ เทมเพลตเพื่อเริ่มต้นใช้งานได้ในการเขียนบทแนะนำ
นอกจากนี้ Google Cloud Platform Community Tutorial Style Guide ยังเป็นแหล่งข้อมูลที่มีประโยชน์สำหรับการเขียนบทแนะนำแบบครบวงจรสำหรับผู้ชมในวงกว้าง ขณะที่Google JavaScript Style Guide จะให้รายละเอียดเกี่ยวกับรูปแบบที่แนะนำสำหรับใช้ในตัวอย่างโค้ด JavaScript ผู้ตรวจสอบอาจอ้างอิงถึงคำแนะนำเหล่านี้ เมื่อตรวจสอบผลงานที่คุณส่ง
หลักเกณฑ์ทั่วไป
- ใช้ข้อความที่กระชับ
- อย่าพูดซ้ำ
- อย่าพูดเรื่องเดียวกันซ้ำ 2 ครั้ง (แม้จะใช้คำพูดต่างกัน)
- ทำเครื่องหมายความคืบหน้าเป็นระยะ
- ใส่รูปภาพและข้อความในจุดสำคัญของบทแนะนำเพื่อให้ผู้ใช้ทราบว่า ตนเองกำลังทำตามขั้นตอนที่ถูกต้อง โปรดใช้เท่าที่จำเป็น
- ใช้โครงสร้างประโยคที่ประธานเป็นผู้กระทำเมื่อเป็นไปได้
- "เมื่อผู้ใช้เปลี่ยนค่า" ไม่ใช่ "เมื่อมีการเปลี่ยนค่า"
- ข้อยกเว้น: คุณใช้กริยาในรูปกรรมวาจกได้ในกรณีที่ต้องใช้กริยาในรูปกรรมวาจก หรือหากผู้กระทำชัดเจนหรือไม่เกี่ยวข้อง ("ระบบแสดง GIF ภาพเคลื่อนไหว" แทน "Earth Engine แสดง GIF ภาพเคลื่อนไหว")
- โปรดยึดข้อเท็จจริง
- หลีกเลี่ยงการใช้คำที่แสดงถึงระดับสูงสุด ("นี่คือวิธีที่ดีที่สุดและเร็วที่สุด100%")
- หลีกเลี่ยงการโปรโมตผลิตภัณฑ์หรือบริการ
- หลีกเลี่ยงหัวข้อที่เป็นประเด็นถกเถียง
- ใส่การอ้างอิงและ URL เมื่ออ้างอิงถึงวิธีการ ชุดข้อมูล และ การวิเคราะห์ที่เฉพาะเจาะจง
- ทำให้บทแนะนำของคุณมีเนื้อหาครบถ้วน
- พยายามอย่าใช้ไลบรารีพิเศษภายนอก API หรือชุดข้อมูลที่ไม่ได้อยู่ในแคตตาล็อกข้อมูล Earth Engine สาธารณะ
- หากคุณให้ข้อมูลหรืออัลกอริทึมเพิ่มเติม โปรดแชร์เฉพาะในกรณีที่คุณ ได้รับอนุญาตให้ทำเช่นนั้น และระบุใบอนุญาตและการระบุแหล่งที่มาที่จำเป็นทั้งหมด
- ทดสอบโค้ด
- โปรดเรียกใช้และทดสอบตัวอย่างโค้ดทั้งหมดที่รวมไว้ก่อนส่งบทความเข้ารับการตรวจสอบ
ส่วนหัวของไฟล์บทแนะนำ
หากสร้างและส่งบทแนะนำของชุมชนด้วยตนเองโดยไม่ใช้เทมเพลตที่ระบุไว้ในการเขียนบทแนะนำ คุณจะต้องเพิ่มข้อมูลเมตาและส่วนหัวของใบอนุญาตที่เหมาะสมที่จุดเริ่มต้นของไฟล์ด้วยตนเอง เลือกรูปแบบที่ต้องการเพื่อดูเทมเพลตที่คัดลอกลงในบทแนะนำของคุณเองได้
Markdown
เพิ่มข้อความต่อไปนี้ที่จุดเริ่มต้นของเอกสาร ไม่ควรมีช่องว่างหรืออักขระอื่นๆ ก่อนส่วนหัว
---
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.
-->
อย่าลืมแทนที่ช่องเทมเพลตที่เหมาะสมก่อนส่ง บทแนะนำเข้ารับการตรวจสอบ
Colab
เพิ่มข้อมูลต่อไปนี้ลงในเซลล์โค้ดที่จุดเริ่มต้นของ 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.
เทมเพลตบทแนะนำ
Markdown
หากคุ้นเคยกับ Git และ GitHub คุณอาจใช้โค้ดด้านล่างเป็น เทมเพลตเพื่อเริ่มต้นใช้งาน
---
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.
หรือจะเปิดเทมเพลตข้างต้นในโปรแกรมแก้ไขไฟล์บนเว็บของ GitHub โดยตรงก็ได้โดยทำตามวิธีการที่การเขียน บทแนะนำ
อย่าลืมดูการเขียนบทแนะนำเพื่อดูรายละเอียดสำคัญเกี่ยวกับ วิธีเสนอ เขียน และส่งบทแนะนำ
Colab
หากต้องการสร้างสมุดบันทึก Colab ใหม่โดยใช้เทมเพลตสไตล์ที่แนะนำ ให้คลิก ที่นี่
ซึ่งจะเปิด Notebook ที่มีวิธีการเขียนและส่งบทแนะนำ โปรดดูรายละเอียดสำคัญเกี่ยวกับกระบวนการเสนอ การเขียน และการส่งได้ที่การเขียนบทแนะนำ