نظرة عامة
يقدّم هذا الدليل إرشادات عامة لكتابة برامجك التعليمية الخاصة حول Google Earth Engine. يهدف هذا البرنامج إلى تسهيل إنشاء برامج تعليمية عالية الجودة تتسم بالوضوح والإيجاز وسهولة الفهم لجميع أفراد منتدى Earth Engine.
يمكنك استخدام نماذج الأدلة التعليمية أدناه كدليل إضافي لمساعدتك في بدء إنشاء أدلتك التعليمية. يمكنك الاطّلاع على تفاصيل حول كيفية استخدام النماذج للبدء في كتابة دليل تعليمي.
بالإضافة إلى ذلك، يقدّم دليل أسلوب الكتابة الخاص بالبرامج التعليمية في Google Cloud Platform Community مرجعًا قيّمًا لكتابة برامج تعليمية شاملة تستهدف جمهورًا واسعًا، بينما يوضّح دليل أسلوب الكتابة الخاص بلغة JavaScript من Google الأسلوب المقترَح للاستخدام في نماذج رموز JavaScript. وقد يستند المراجعون إلى هذه الأدلة عند مراجعة المحتوى الذي أرسلته.
الإرشادات العامة
- كن موجزًا.
- لا تكرّر المحتوى.
- لا تكرّر الكلام نفسه مرّتين (حتى لو كانت الصياغة مختلفة).
- تحديد مستوى التقدّم بشكل دوري
- ضمِّن صورًا ونصوصًا في نقاط رئيسية من البرنامج التعليمي ليعرف المستخدم أنّه يسير على المسار الصحيح. يجب استخدامها باعتدال.
- استخدِم صيغة المعلوم كلّما أمكن.
- "عندما يغيّر المستخدم القيمة"، وليس "عندما يتم تغيير القيمة".
- استثناء: لا بأس من استخدام صيغة المجهول عندما يكون من الصعب استخدام صيغة المعلوم، أو إذا كان الفاعل واضحًا أو غير مهم (مثلاً، "يتم عرض صورة GIF متحركة" بدلاً من "تعرض Earth Engine صورة GIF متحركة").
- الالتزام بالحقائق
- تجنَّب استخدام صيغ التفضيل ("هذه هي أفضل وأسرع طريقة").
- تجنَّب الترويج للمنتجات أو الخدمات.
- تجنَّب المواضيع الجدلية.
- يجب تضمين الاقتباسات وعناوين URL عند الإشارة إلى طرق ومجموعات بيانات وتحليلات معيّنة.
- يجب أن يكون البرنامج التعليمي مكتملًا.
- حاوِل عدم الاعتماد على مكتبات خاصة خارج واجهة برمجة التطبيقات أو مجموعات البيانات غير المتوفّرة في كتالوج بيانات 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
أضِف ما يلي إلى خلية رمز في بداية دفتر الملاحظات:
#@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 جديدة باستخدام نموذج الأسلوب المقترَح، انقر هنا:
سيؤدي ذلك إلى فتح دفتر ملاحظات يحتوي على تعليمات حول إنشاء البرنامج التعليمي وإرساله. يُرجى الرجوع إلى كتابة برنامج تعليمي للحصول على تفاصيل مهمة حول عملية الاقتراح والتأليف والإرسال.