개요
이 가이드에서는 자체 Google 어스 엔진 튜토리얼을 작성하기 위한 일반적인 가이드라인을 제공합니다. 전체 Earth Engine 커뮤니티에서 명확하고 간결하며 쉽게 이해할 수 있는 고품질 튜토리얼을 쉽게 만들 수 있도록 하는 것을 목표로 합니다.
아래의 튜토리얼 템플릿은 자체 튜토리얼을 시작하는 데 도움이 되는 추가 가이드로도 사용할 수 있습니다. 템플릿을 사용하여 시작하는 방법에 대한 자세한 내용은 튜토리얼 작성을 참조하세요.
또한 Google Cloud 커뮤니티 튜토리얼 스타일 가이드는 광범위한 잠재고객을 위한 엔드 투 엔드 튜토리얼을 작성하는 데 유용한 참조를 제공하며, Google JavaScript 스타일 가이드는 JavaScript 코드 샘플에 사용하기 위해 권장되는 스타일을 자세히 설명합니다. 검토자는 제출물을 검토할 때 이 가이드를 참고할 수 있습니다.
일반 가이드라인
- 간결하게 작성합니다.
- 반복하지 마세요.
- 같은 내용을 두 번 말하지 마세요 (표현이 다르더라도).
- 주기적으로 진행 상황을 표시합니다.
- 사용자가 제대로 진행하고 있는지 알 수 있도록 튜토리얼의 주요 지점에 이미지와 텍스트를 포함합니다. 가급적 사용하지 마세요.
- 가능하면 능동태를 사용합니다.
- '값이 변경될 때'가 아니라 '사용자가 값을 변경할 때'입니다.
- 예외: 능동태를 사용하기 위해 무리하게 문장을 수정해야 하거나 행위자가 명확하거나 관련이 없는 경우 ('Earth Engine returns an animated GIF' 대신 'an animated GIF is returned') 수동태를 사용해도 됩니다.
- 사실에 집중하세요.
- 최상급 표현 ("이것은 100% 가장 좋고 가장 빠른 방법입니다")은 피합니다.
- 제품이나 서비스를 홍보하지 마세요.
- 논란의 여지가 있는 주제는 피하세요.
- 특정 메서드, 데이터 세트, 분석을 참조할 때는 인용 및 URL을 포함합니다.
- 튜토리얼을 독립적으로 만듭니다.
- API 외부의 특수 라이브러리나 공개 Earth Engine 데이터 카탈로그에 없는 데이터 세트에 의존하지 마세요.
- 추가 데이터나 알고리즘을 제공하는 경우 권한이 있는 경우에만 공유하세요. 필요한 모든 라이선스와 저작자 표시를 포함하세요.
- 코드를 테스트합니다.
- 검토를 위해 도움말을 제출하기 직전에 포함된 모든 코드 샘플을 실행하고 테스트해야 합니다.
튜토리얼 파일 헤더
튜토리얼 작성에 제공된 템플릿을 사용하지 않고 커뮤니티 튜토리얼을 수동으로 만들고 제출하는 경우 파일 시작 부분에 적절한 메타데이터와 라이선스 헤더를 수동으로 추가해야 합니다. 원하는 형식을 선택하여 자체 튜토리얼에 복사할 수 있는 템플릿을 확인합니다.
마크다운
문서 시작 부분에 다음을 추가합니다. 헤더 앞에 공백이나 다른 문자가 없어야 합니다.
---
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.
튜토리얼 템플릿
마크다운
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 노트북을 만들려면 여기를 클릭하세요.
그러면 튜토리얼 작성 및 제출 안내가 포함된 노트북이 열립니다. 제안서, 작성, 제출 프로세스에 관한 중요한 세부정보는 튜토리얼 작성을 참고하세요.