खास जानकारी
इस गाइड में, Google Earth Engine के ट्यूटोरियल लिखने के लिए सामान्य दिशा-निर्देश दिए गए हैं. इसका मकसद, अच्छी क्वालिटी के ट्यूटोरियल बनाने की प्रोसेस को आसान बनाना है. ये ट्यूटोरियल साफ़ तौर पर, कम शब्दों में, और आसानी से समझ में आने वाले होने चाहिए, ताकि Earth Engine की पूरी कम्यूनिटी को इनसे मदद मिल सके.
यहां दिए गए ट्यूटोरियल टेंप्लेट, ट्यूटोरियल बनाने में आपकी मदद करने के लिए एक अतिरिक्त गाइड के तौर पर भी काम करते हैं. टेंप्लेट इस्तेमाल करने के तरीके के बारे में जानकारी, ट्यूटोरियल लिखना में मिल सकती है.
इसके अलावा, Google Cloud कम्यूनिटी ट्यूटोरियल स्टाइल गाइड में, ज़्यादा से ज़्यादा लोगों के लिए सिलसिलेवार ट्यूटोरियल लिखने के बारे में अहम जानकारी दी गई है. वहीं, Google JavaScript स्टाइल गाइड में, JavaScript कोड सैंपल में इस्तेमाल करने के लिए सुझाई गई स्टाइल के बारे में बताया गया है. समीक्षक, आपके सबमिट किए गए कॉन्टेंट की समीक्षा करते समय इन गाइड का इस्तेमाल कर सकते हैं.
सामान्य दिशा-निर्देश
- कम शब्दों का इस्तेमाल करें.
- एक ही बात को बार-बार न दोहराएं.
- एक ही बात को दो बार न कहें. भले ही, उसे अलग-अलग शब्दों में कहा गया हो.
- समय-समय पर प्रोग्रेस को मार्क करें.
- ट्यूटोरियल के अहम हिस्सों में इमेज और टेक्स्ट शामिल करें, ताकि उपयोगकर्ता को पता चले कि वह सही दिशा में आगे बढ़ रहा है. कम से कम इस्तेमाल करें!
- जहां तक हो सके, ऐक्टिव वॉइस का इस्तेमाल करें.
- "जब उपयोगकर्ता वैल्यू बदलता है", न कि "जब वैल्यू बदलती है".
- अपवाद: पैसिव वॉइस का इस्तेमाल तब किया जा सकता है, जब ऐक्टिव वॉइस का इस्तेमाल करने के लिए आपको बहुत ज़्यादा मेहनत करनी पड़े. इसके अलावा, अगर ऐक्टर साफ़ तौर पर दिख रहा हो या काम का न हो, तो भी पैसिव वॉइस का इस्तेमाल किया जा सकता है. जैसे, "Earth Engine, ऐनिमेट किया गया GIF दिखाता है" के बजाय "ऐनिमेट किया गया GIF दिखाया जाता है".
- तथ्यों पर आधारित जानकारी दें.
- बढ़ा-चढ़ाकर बताने वाले शब्दों का इस्तेमाल न करें ("यह 100% सबसे अच्छा और सबसे तेज़ तरीका है").
- प्रॉडक्ट या सेवाओं का प्रमोशन करने से बचें.
- विवादित विषयों पर वीडियो बनाने से बचें.
- किसी खास तरीके, डेटासेट, और विश्लेषण का रेफ़रंस देते समय, उद्धरण और यूआरएल शामिल करें.
- अपने ट्यूटोरियल को सेल्फ़-कंटेन्ड बनाएं.
- एपीआई के बाहर मौजूद खास लाइब्रेरी या सार्वजनिक 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 notebook बनाने के लिए, यहां क्लिक करें:
इससे एक नोटबुक खुलेगी. इसमें ट्यूटोरियल बनाने और उसे सबमिट करने के निर्देश होंगे. प्रपोज़ल, कॉन्टेंट बनाने, और उसे सबमिट करने की प्रोसेस के बारे में अहम जानकारी पाने के लिए, ट्यूटोरियल लिखना लेख ज़रूर पढ़ें.