ภาพรวม
คู่มือนี้จะให้หลักเกณฑ์ทั่วไปสำหรับการเขียนบทแนะนำ Google Earth Engine ของคุณเอง โดยมีเป้าหมายเพื่อช่วยให้สร้างบทแนะนำคุณภาพสูงที่ชัดเจน กระชับ และเข้าใจง่ายสำหรับชุมชน Earth Engine ทั้งหมดได้ง่ายๆ
เทมเพลตบทแนะนำด้านล่างยังทำหน้าที่เป็นคู่มือเพิ่มเติมเพื่อช่วยให้คุณเริ่มสร้างบทแนะนำของตัวเองได้ด้วย ดูรายละเอียดเกี่ยวกับวิธีใช้เทมเพลตเพื่อเริ่มต้นใช้งานได้ในการเขียนบทแนะนำ
นอกจากนี้ คู่มือสไตล์สำหรับบทแนะนำของชุมชน Google Cloud ยังเป็นข้อมูลอ้างอิงที่มีประโยชน์สำหรับการเขียนบทแนะนำแบบครบวงจรสำหรับกลุ่มเป้าหมายในวงกว้าง ส่วนคู่มือสไตล์ JavaScript ของ Google จะให้รายละเอียดเกี่ยวกับสไตล์ที่แนะนำสำหรับการใช้ในตัวอย่างโค้ด JavaScript ผู้ตรวจสอบอาจอ้างอิงคำแนะนำเหล่านี้เมื่อตรวจสอบข้อมูลที่คุณส่งมา
หลักเกณฑ์ทั่วไป
- เขียนให้สั้นกระชับ
- อย่าพูดซ้ำ
- อย่าพูดสิ่งเดียวกัน 2 ครั้ง (แม้ว่าจะใช้ถ้อยคำต่างกัน)
- ทำเครื่องหมายความคืบหน้าเป็นระยะๆ
- ใส่รูปภาพและข้อความในจุดสำคัญของบทแนะนำเพื่อให้ผู้ใช้ทราบว่าตนเองกำลังทำตามขั้นตอนอย่างถูกต้อง โปรดใช้เท่าที่จำเป็น
- ใช้โครงสร้างประโยคที่ประธานเป็นผู้กระทำเมื่อเป็นไปได้
- "เมื่อผู้ใช้เปลี่ยนค่า" ไม่ใช่ "เมื่อค่ามีการเปลี่ยนแปลง"
- ข้อยกเว้น: คุณสามารถใช้ประโยคแบบกรรมวาจก (Passive Voice) ได้เมื่อต้องพยายามอย่างมากเพื่อใช้ประโยคแบบกรรตุวาจก (Active Voice) หรือหากผู้กระทำชัดเจนหรือไม่เกี่ยวข้อง ("ระบบจะแสดงผล 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 ใหม่โดยใช้เทมเพลตสไตล์ที่แนะนำ ให้คลิกที่นี่
ซึ่งจะเปิด Notebook ที่มีวิธีการเขียนและส่งบทแนะนำ โปรดอ่านการเขียนบทแนะนำเพื่อดูรายละเอียดที่สำคัญเกี่ยวกับข้อเสนอ การเขียน และขั้นตอนการส่ง