adev-writing-guide은(는) 무엇을 하나요?
Angular 문서(adev) 작성을 위한 종합 가이드입니다. Google 기술 문서 작성 표준, Angular 특화 마크다운 확장, 코드 블록 및 컴포넌트를 다룹니다. adev/ 또는 adev/src/content 디렉토리의 문서 파일을 생성, 편집 또는 검토할 때 반드시 이 스킬을 사용해야 합니다.
목차
Google 기술 문서 작성 표준
이 프로젝트는 Google 기술 문서 작성 표준을 따릅니다. 주요 원칙은 다음과 같습니다:
- 명확성: 간결하고 명확한 문장을 사용하세요.
- 목적 중심: 독자가 문서를 통해 무엇을 배울 수 있는지 명확히 하세요.
- 일관성: 용어와 형식을 일관되게 유지하세요.
- 예제 중심: 개념을 설명할 때 실제 코드 예제를 제공하세요.
참고: Google 기술 문서 작성 표준은 영어 문서에 최적화되어 있지만, 번역 시에도 문장 구조와 명확성을 유지하는 것이 중요합니다.
Angular 특화 마크다운 확장
Angular 문서는 표준 마크다운 외에도 다음과 같은 확장 기능을 사용합니다:
1. 문서 메타데이터
각 문서 파일은 YAML 프론트매터로 시작해야 합니다:
---
title: 컴포넌트 개요
description: Angular 컴포넌트의 기본 개념을 설명합니다.
---
2. 특수 구문
@Component- Angular 컴포넌트 데코레이터를 나타낼 때 사용합니다.@Injectable- 의존성 주입이 가능한 서비스를 나타낼 때 사용합니다.@NgModule- Angular 모듈을 나타낼 때 사용합니다.
3. 크로스 레퍼런스
다른 문서 페이지를 참조할 때는 다음 구문을 사용합니다:
[컴포넌트 개요](/guide/component-overview)
코드 블록
코드 예제는 반드시 펜스 코드 블록으로 작성하고, 언어를 명시해야 합니다:
@Component({
selector: 'app-example',
template: `
<h1>{{ title }}</h1>
`
})
export class ExampleComponent {
title = 'Hello Angular';
}
<app-example></app-example>
코드 블록 규칙
- 모든 코드 블록에 언어 식별자를 추가하세요 (예:
typescript,html,css,bash). - 실제 실행 가능한 코드만 포함하세요.
- 주석은 코드 설명이 필요한 경우에만 최소한으로 사용하세요.
컴포넌트
Angular 문서는 다음과 같은 특수 컴포넌트를 지원합니다:
알림 박스
:::note
이것은 참고 사항입니다.
:::
:::tip
유용한 팁을 여기에 작성합니다.
:::
:::warning
중요한 경고 사항입니다.
:::
코드 예제 컴포넌트
<code-example header=