쓰기 안내서

MDN 웹 문서는 오픈 소스 프로젝트입니다. 아래에 요약된 섹션은 저희가 문서화하는 것과 MDN 웹 문서에서 문서화하는 방법에 대한 지침을 설명합니다. 기여 방법에 대해 알아보려면 기여 안내서를 참조하세요.

이 섹션에서는 MDN 웹 문서에 포함하는 것과 포함하지 않는 것, 그리고 새로운 기술을 작성할 때, 콘텐츠 제안 과정, 외부 링크 허용 여부와 같은 기타 여러 정책에 대해 다룹니다. 저희를 위해 콘텐츠를 작성하거나 갱신하는 것을 고려하고 있다면 이곳이 좋은 출발점 일겁니다. 이 섹션은 다음도 포함합니다.

포함 기준: MDN 웹 문서에 포함할 콘텐츠에 대한 심층적인 기준, MDN 웹 문서에 새 문서를 추가하기 위한 신청 과정, 그리고 신청 당사자에 대한 기대와지침을 제공합니다.

쓰기 스타일 안내서

쓰기 스타일 안내서는 MDN 웹 문서 작성에 사용하는 언어와 스타일을 다룹니다. 코드 예제의 형식을 지정하는 방법도 다룹니다.

MDN 웹 문서를 쓰는 방법

이 섹션에서는 저희가 준수하는 특정 과정과 기술을 포함하여 페이지 생성과 편집에 대한 모든 정보를 다룹니다. 이 섹션에서는 시작하기, 페이지 구성 방법에 대한 일반적인 개요, 그리고 특정 작업에 대한 방법을 찾을 수 있는 곳에 대한 정보를 제공합니다. 이 섹션에는 다음 주제가 포함됩니다.

기술을 검색하는 방법: 이 섹션에서는 여러분이 문서화 중인 기술에 대해 검색하기 위한 몇 가지 유용한 팁을 제공합니다.
페이지를 생성, 이동, 삭제하는 방법: 이 섹션에서는 MDN 웹 문서에서 페이지를 생성, 이동 또는 삭제하는 방법에 대해 설명합니다. 또한 페이지를 이동하거나 삭제할 때 페이지를 리다이렉션하는 방법에 대해서도 설명합니다.
마크다운을 사용하는 방법: 저희가 사용하는 마크다운 형식은 GitHub flavored markdown (GFM)에서 파생됩니다. 이 섹션은 참고와 정의 목록과 같은 특정 페이지 내 구성 요소에 대한 형식을 포함한 MDN 웹 문서에서 사용하는 마크다운에 대한 안내서입니다.
이미지와 미디어 추가하기: 이 섹션에서는 이미지와 같은 미디어를 페이지에 포함시키기 위한 요구 사항을 설명합니다.
CSS 속성을 문서화하는 방법: 이 문서에서는 레이아웃과 콘텐츠를 포함하여 CSS 속성 페이지를 작성하는 방법을 설명합니다.
API 참조를 문서화하는 방법: 이 섹션에서는 Web API를 문서화하는 방법에 대해 설명합니다.
HTTP 헤더를 문서화하는 방법: 이 문서에서는 HTTP 헤더에 대한 새 참조 페이지를 만드는 방법에 대해 설명합니다.
용어집에 항목을 추가하는 방법: 이 문서는 MDN 웹 문서 용어집에 항목을 추가하고 링크하는 방법에 대해 설명합니다. 또한 용어집 항목의 레이아웃과 콘텐츠에 대한 지침을 제공합니다.

MDN 웹 문서의 페이지 유형

CSS 참조 페이지든 JavaScript 안내서 페이지든 MDN 웹 문서의 각 페이지에는 특정 페이지 유형이 있습니다. 이 섹션에서는 다양한 페이지 유형을 나열하고 각 유형에 대한 템플릿을 제공합니다. 작성 중인 페이지 유형을 이해하려면 이러한 항목을 찾아보는 것이 좋습니다.

MDN 웹 문서의 페이지 구조

이 섹션에서는 MDN 웹 문서에서 정보를 일관되게 표시하기 위해 사용하는 다양한 페이지 구조를 다룹니다. 다음이 포함됩니다.

구문 섹션: MDN 웹 문서에 있는 참조 페이지의 구문 섹션에는 기능의 정확한 구문을 정의하는 구문 상자가 포함되어 있습니다. 이 문서는 참조 문서에 대한 구문 상자를 작성하는 방법을 설명합니다.
코드 섹션: 페이지에 코드 예제를 포함하는 방법에는 여러 가지가 있습니다. 이 섹션은 이에 대한 개요를 설명하고 다양한 언어에 대한 구문 지침을 제공합니다.
배너와 알림: 경우에 따라 문서에 특별한 알림이 추가되어야 합니다. 페이지에서 더 이상 사용되지 않는 기술이나 프로덕션 코드에 사용하면 안 되는 기타 자료를 다루는 경우 이러한 상황이 발생할 수 있습니다. 이 문서에서는 가장 일반적인 경우와 이를 처리하는 방법을 다룹니다.
명세서 표: MDN 웹 문서의 모든 참조 페이지는 해당 API 또는 기술이 정의된 명세에 대한 정보를 제공해야 합니다. 이 문서는 이러한 표의 모양과 표를 추가하는 방법을 설명합니다.
호환성 표: MDN 웹 문서에는 개방형 웹 문서의 호환성 표에 대한 표준 형식이 있습니다. 이 문는 호환성 표를 생성하는 데 사용되는 데이터베이스를 추가하고 유지 관리하는 방법과 테이블을 문서에 통합하는 방법에 대해 설명합니다.
매크로: 매크로는 페이지에서 사이드바와 같은 콘텐츠를 생성하는 데 사용되는 바로가기입니다. 이 섹션에서는 저희가 사용하는 매크로와 그 기능을 나열합니다.

웹의 다른 곳에서 MDN 웹 문서 콘텐츠를 사용하는 것에 대한 정책, MDN에서 콘텐츠를 재배포할 수 있는 권한을 얻는 방법, 그리고 MDN 콘텐츠에 링크하기 위한 힌트를 설명합니다.

기술에 레이블을 지정하는 방법

이 섹션에서는 obsolete, deprecated, 그리고 experimental 이라는 용어에 대한 정의를 다루고 이러한 용어를 기술에 레이블하는 방법과 MDN 웹 문서에서 콘텐츠를 제거하는 시기에 대한 지침을 제공합니다.