GitLab 문서 작성 스타일 가이드
GitLab v19.2요약
문서를 작성하기 전에 문서 원칙 파일을 읽고 따르세요. 반복: 동일한 페이지의 앞 부분이나 연결된 주제에서 이미 다룬 정보를 다시 서술하지 마세요. 모호하거나 검증할 수 없는 주장: 코드베이스나 기존 문서에 근거할 수 없다면 기능의 작동 방식을 설명하지 마세요.
출력 요구사항#
-
완전한 문서를 작성하세요.
-
문서를 작성하기 전에 문서 원칙 파일을 읽고 따르세요. 원칙 파일은 저장소 루트에 있습니다.
.ai디렉터리를 열고principles/distilled/documentation.md를 읽으세요.
AI가 생성한 문서에서 피해야 할 흔한 실수#
-
반복: 동일한 페이지의 앞 부분이나 연결된 주제에서 이미 다룬 정보를 다시 서술하지 마세요.
-
모호하거나 검증할 수 없는 주장: 코드베이스나 기존 문서에 근거할 수 없다면 기능의 작동 방식을 설명하지 마세요.
-
잘못된 범위: 적절한 페이지가 이미 존재하는 경우 개념이나 절차를 위해 새 페이지를 만들지 마세요.
-
스타일 가이드 준수: 스타일 가이드의 용어, 문법, 서식을 따르세요.