문서화 AGENTS.md

Writing styles, markup, formatting, and other standards for GitLab Documentation.

AGENTS.md 파일은 GitLab Duo에 대한 문서화 지침을 제공합니다. 에이전트가 gitlab/doc 디렉토리에 문서를 작성할 때, AGENTS.md 를 자동으로 읽고 해당 지침을 출력에 적용합니다. AI 생성 콘텐츠를 검토를 위해 제출하기 전에 다음을 확인하세요: 콘텐츠가 정확합니다. 환각(hallucination) 및 반복적인 콘텐츠와 같은 AI 생성 콘텐츠의 일반적인 문제가 해결되었습니다. AGENTS.md 사용 # AGENTS.md 는 각 새 GitLab Duo Chat 대화 시작 시 자동으로 적용됩니다. 프롬프트에서 이를 참조할 필요가 없습니다. 최상의 결과를 얻으려면: 문서화 작업을 시작하기 전에 새 채팅 대화를 시작합니다. 로컬에서만 변경합니다. 검토하고 반복하기 전에 AI 생성 콘텐츠를 커밋하거나 푸시하지 마세요. 위치 # AGENTS.md 파일은 gitlab/doc/AGENTS.md 에 위치합니다. 해당 위치 때문에 지침은 문서화에만 적용됩니다. 기여자가 코드베이스의 관련 없는 부분에서 작업할 때는 지침이 적용되지 않습니다. AI 생성 콘텐츠 검토 # 검토를 요청하기 전에 AI 생성 콘텐츠의 다음 알려진 문제를 확인하세요: 반복: 페이지나 연결된 주제에서 이미 언급된 내용을 다시 설명하는 콘텐츠. 모호하거나 확인 불가능한 주장: 코드베이스나 기존 문서에 기반하지 않은 기능 작동 방식에 대한 설명. 잘못된 범위: 적합한 페이지가 이미 존재하는 경우 개념이나 절차에 대해 새 페이지가 생성됨. 확실하지 않은 경우 기술 작가가 문서의 위치를 식별하는 데 도움을 줄 수 있습니다. 스타일 가이드 준수: 스타일 가이드 와 일치하지 않는 용어, 문법, 서식. AGENTS.md 업데이트 # AI 생성 콘텐츠에서 반복적인 패턴을 발견하면, MR을 열어 지침을 추가하거나 개선합니다. 파일을 업데이트할 때 다음 원칙을 따르세요: 지침을 구체적이고 실행 가능하게 유지합니다. 간결하게 작성 과 같은 모호한 지침을 피합니다. 지침에 판단이 필요한 경우 예시를 사용합니다. 마케팅 언어 피하기 대신 예시를 제공합니다: 마케팅 언어를 피합니다. 예를 들어, "강력한" 또는 "끊김 없는"을 사용하지 마세요 . 변경 사항을 테스트합니다. 새 채팅 대화를 시작하고 지침이 적용되는지 확인합니다. AGENTS.md 를 업데이트하면 변경 사항이 적용되려면 대화를 다시 시작해야 합니다. 기존 대화는 변경 사항을 자동으로 반영하지 않습니다.