기술 자료 검토자는 지원 문서를 작성하는 데 경험과 기술을 갖춘 Mozilla 기여자 및 직원입니다. 다음은 문서 검토에 대한 몇 가지 지침입니다.
목적
기술 자료 검토자로서 귀하의 역할은 기술 자료의 지원 콘텐츠의 정확성, 명확성 및 일관성을 유지하는 데 필수적입니다. 귀하의 검토 작업을 통해 사용자는 문서를 신뢰하고 쉽게 도움을 찾을 수 있습니다.
주요 책임
KB 검토자로서 수정본을 검토할 때 항상 수정본이 다음을 충족하는지 확인하십시오:
- 정확하고 최신 상태입니다
- 명확하고 일관된 언어와 어조를 사용합니다
- Mozilla의 편집 지침을 따릅니다
- 올바르고 작동하는 서식, 링크 및 마크업을 포함합니다
- 접근성 및 현지화 모범 사례를 따릅니다
- 문서 및 제품 버전의 범위를 충족합니다
검토 지침
대부분의 수정은 시간과 재능을 자원하는 사람들에 의해 이루어집니다. 사람들이 제출한 작업을 처리할 때 모든 사람이 최선의 의도를 가지고 있다고 가정하고 그들의 기여에 대해 감사해야 합니다. 기억하세요, 당신은 그 사람이 Mozilla의 누군가와 처음이자 유일한 접촉일 수 있습니다. 긍정적으로 만들어 주세요.
기술 자료 검토 정책
주요 업데이트의 경우 콘텐츠 승인과 콘텐츠 검토는 두 가지 별개의 프로세스이므로 구분하는 것이 중요합니다.
- 콘텐츠 승인은 주로 콘텐츠의 기술적 정확성을 검증하기 위해 제품 이해 관계자가 수행합니다.
- 콘텐츠 검토는 편집 품질과 문서 서식을 보장하기 위해 KB 검토자가 수행합니다.
이 구분에 대한 자세한 내용은 콘텐츠 요청에 대한 기여자 할당을 참조하세요.
직원 검토가 필요한 경우
다음과 같은 경우 직원 검토가 필요합니다:
- 새 문서
- 수정 노트에 "직원 검토 필요"라고 명시적으로 표시된 주요 업데이트
KB 검토 권한이 있는 기여자는 언제 수정본을 검토할 수 있나요?
KB 검토 권한이 있는 기여자는 다음을 검토할 수 있습니다:
- 사소한 변경으로 분류된 수정본
- 직원 검토가 필요하지 않은 주요 변경 사항
콘텐츠 업데이트가 범위와 영향에 따라 어떻게 분류되는지에 대한 자세한 내용은 Minor vs major changes를 참조하세요.
검토되지 않은 문서를 찾는 곳
검토되지 않은 문서를 찾는 방법에는 여러 가지가 있습니다:
- 기술 자료 개요: 이 페이지는 지난 30일 동안의 페이지 조회수 순서로 문서 목록을 제공합니다. 상태 열에는 검토가 필요한 문서가 표시됩니다. 제품 및 문서 유형에 따라 필터링할 수도 있습니다.
- 검토되지 않은 변경 사항: 이 페이지는 검토가 필요한 문서와 각 수정본이 검토를 기다린 시간을 확인할 수 있는 다른 방법을 제공합니다. 페이지 조회수/최신 변경 사항을 기준으로 정렬하도록 선택할 수 있으며 제품을 기준으로 필터링할 수도 있습니다.
- 가장 많이 방문한 문서: 이 페이지는 페이지 조회수를 기준으로 기술 자료 문서 목록을 제공합니다. 상태 열에서 검토가 필요한 문서를 확인할 수 있습니다.
우선 순위 지정
여러 문서를 검토할 때 전략적으로 노력의 우선 순위를 정하는 것이 중요합니다. 다음을 고려하세요:
- 페이지 조회수가 높은 문서: 조회수가 많은 문서는 사용자가 가장 정확하고 최신 정보에 접근할 수 있도록 우선적으로 처리해야 합니다. 검토되지 않은 변경 사항 목록을 조회수로 정렬하여 쉽게 식별할 수 있습니다.
- 제품 내에 링크된 문서: 기여 그룹(포럼, KB, L10n) 또는 "직원" 그룹의 일원인 경우 제품 내에 문서가 링크되어 있음을 보여주는 표시기를 볼 수 있습니다. 이러한 문서는 사용자 경험에 직접적인 영향을 미치므로 일반적으로 우선 순위를 가져야 합니다.
특수 문서
- 템플릿은 여러 문서에서 재사용되는 콘텐츠를 포함하며 더 넓은 영향으로 인해 높은 우선 순위로 간주되어야 합니다. 검토가 필요한 템플릿을 포함한 모든 템플릿은 이 보드에 나열되어 있습니다. 문서 내에서 템플릿을 사용하는 방법에 대한 지침은 템플릿을 사용하는 방법를 참조하세요.
- 미리 준비된 답변은 커뮤니티 포럼에서 사용되는 표준화된 응답입니다. 자주 재사용되므로 모든 업데이트는 커뮤니티 팀과 협의해야 합니다. 검토가 필요한 응답을 포함한 모든 포럼 응답 목록은 이 다른 보드에서 확인할 수 있습니다. 일반적인 응답을 만들거나 개선하는 방법에 대한 추가 지침은 공통 포럼 답변 생성 또는 개선를 참조하세요.
구독 또는 프리미엄 제품에 대한 특별 요구 사항
콘텐츠 제출
새로운 콘텐츠를 제안하거나 변경 사항을 제안하려면 Bugzilla 티켓을 제출하거나 직원에게 문의하세요. Matrix에서 또는 Slack의 #sumo-team 채널(Slack 액세스 권한이 있는 기여자)에서 저희에게 연락할 수 있습니다.
KB 수정본 검토 및 승인
구독 또는 프리미엄 제품과 관련된 모든 수정본에 대해서는 직원 승인이 필요합니다. 여기에는 이러한 제품과 관련된 미리 준비된 답변 및 템플릿이 포함됩니다.
참고로 현재 구독 또는 프리미엄 제품은 다음과 같습니다:
- Mozilla VPN
- Firefox Relay
- Mozilla Monitor
- MDN Plus
문서 검토하기
수정본 수준 선택
문서를 승인할 때 세 가지 다른 수정본 수준 중에서 선택할 수 있습니다. 이 수준은 현지화의 필요성과 우선 순위를 결정합니다.
- 지침에 영향을 미치지 않는 사소한 세부 사항: 사용자에게 지침을 변경하지 않는 변경 사항입니다. 현지화 담당자에게는 이러한 변경 사항이 통지되지 않습니다.
- 즉각적인 번역이 필요하지 않은 콘텐츠 변경: 이것이 기본 선택입니다. 이것은 문서의 이전 버전을 완전히 무효화하지 않는 주요 변경 사항(업데이트 및 큰 변경)입니다. 현지화 담당자에게는 변경 사항이 즉시 통지되지 않지만, 나중에 수정본을 현지화 준비 완료로 표시할 수 있으며 현지화 담당자에게 알림이 트리거됩니다.
- 이전 번역을 부정확하게 만드는 주요 콘텐츠 변경: 업데이트로 인해 이전 콘텐츠가 오래된 것이 될 때 사용할 수 있습니다. 이렇게 문서를 표시하면 현지화된 문서에 콘텐츠가 오래되었을 수 있다는 경고가 표시되고 가장 업데이트된 정보를 위해 영어 버전으로의 링크가 제공됩니다.
편집자에게 피드백 남기기
문서를 승인할 때 편집자들의 기여에 감사하는 것이 중요합니다. 피드백을 주는 것도 좋습니다. 그들의 글쓰기 실력이 향상되었나요? 복잡한 것을 특히 잘 설명했나요? 그들에게 알려주세요!
수정본 보류
수정본이 특별히 도움이 되지 않는 경우 제안된 수정본을 보류할 수 있습니다. 그러나 단순한 거절이 아니라 보류는 수정본 작성자와 협력하여 수정본을 개선할 수 있는 기회입니다. 댓글 필드에 메시지를 남겨 작성자에게 감사 인사를 전한 다음, 수정본이 수락 가능해지기 위해 변경해야 할 사항에 대해 구체적이고 건설적인 피드백을 제공할 수 있습니다. 관련 문서나 지침에 대한 링크도 반드시 포함해야 합니다.
여러 수정본 검토
여러 수정본이 승인 대기 중일 때, 새 수정본을 승인하기 전에 가장 오래된 것부터 시작하여 모든 이전 수정본을 승인하거나 보류해야 합니다. 새 수정본이 승인되면 이전 수정본을 검토할 수 없다는 점에 유의하는 것이 중요합니다. 여전히 승인 대기 중인 것으로 표시되지만 검토할 수는 없습니다.
변경 필요
수정본을 승인할 때, 변경해야 할 사항이 아직 남아 있는지 결정해야 합니다. "변경 필요" 주석에 명시된 모든 사항이 처리되었다면, 체크를 해제하고(주석을 지우고) 문서를 승인할 수 있습니다. 아직 해야 할 일이 남아 있다면, 체크박스가 선택되었는지 확인하고 주석을 업데이트하세요. 이렇게 하면 문서에서 수행해야 할 작업을 쉽게 추적할 수 있습니다.
크레딧 제공
때로는 문서에 대한 토론에 참여하는 사람들이 실제로 위키를 편집한 사람이 아니더라도 수정본에 상당한 기여를 하는 경우가 있습니다. 이와 같은 경우, 문서의 기여자 목록(문서 기록 페이지)을 편집하여 그들을 포함시킬 수 있습니다. 이 사실을 그들에게 알려주면 보너스 포인트를 얻을 수 있습니다!
KB에서 기여자에게 크레딧을 주는 방법
- 기여자를 추가하려면 문서의 기록 보기 페이지로 이동하세요
- 수정본 아래로 스크롤하여 기여자 편집 링크를 클릭하세요
- 기여자 이름을 입력한 다음 를 클릭하세요
스팸 및 잘못된 편집 처리
스팸의 경우, 문서 수정 기록에서 휴지통 아이콘을 클릭하고 확인하여 수정본을 간단히 삭제해야 합니다. 잘못된 제출(변경 사항 없음) 및 잘못된 도움 요청(편집이 기본적으로 지원 질문인 경우)의 경우, 보류하고 주석에 다음 메시지를 포함해야 합니다:
안녕하세요.
Firefox에 대한 도움을 받으려고 하셨던 것 같습니다. 만약 그렇다면, 더 나은 도움을 드릴 수 있도록 https://support.mozilla.org/questions/new 에서 다시 질문해 주세요.
불편을 드려 죄송합니다.
이 작업을 완료하면 수정본을 삭제할 수 있습니다.
현지화 준비 완료
"현지화 준비 완료"(RFL)는 어떻게 작동하나요?
기여자가 아직 업데이트 중인 문서를 번역하는 것을 방지하기 위해 시스템은 현지화 준비 완료(RFL)로 명시적으로 표시된 버전의 번역만 허용합니다. 현지화 담당자가 를 클릭하면 RFL로 표시된 가장 최근 수정본이 제공됩니다.
새 수정본이 승인된 후, 현지화 준비 완료(RFL) 플래그가 선택되지 않으면 문서는 현지화 대시보드에 업데이트가 필요한 것으로 표시되지 않습니다. RFL 플래그가 설정되면 시스템은 문서를 주시하는 모든 사람에게 이메일 알림을 보내 문서가 현지화될 준비가 되었음을 알립니다.
문서를 RFL로 표시하기
문서 수정본을 "현지화 준비 완료"로 표시하는 것은 현지화 담당자에게 영어 버전이 완료되었으며, 그들이 작업을 완료하기 전에 문서가 몇 번 더 변경될 것이라는 두려움 없이 번역할 수 있음을 알리는 것을 의미합니다.
현지화는 많은 작업이며 종종 한 사람이 수행합니다. 항상 쉬운 것은 아니지만, 현지화 담당자가 추가 시간을 사용하여 작업을 완료할 수 있도록 Firefox 출시 전에 모든 필수 변경 사항이 완료되었는지 확인하십시오.
검토 후 문서를 RFL로 표시하기
수정본을 승인할 때 현지화 준비 완료로 표시하지 않는 경우(위의 경우와 같이), 문서 수정 기록의 R 열 아래에 있는 "현지화 준비 안 됨" 상태 항목(✕ 기호)을 클릭하고 확인하여 언제든지 준비 완료로 표시할 수 있습니다.
RFL로 표시된 수정본에는 체크 표시 기호 ✓가 있습니다.
RFL 프로토콜
모든 기여자 검토자는 다음 현지화 프로토콜을 준수해야 합니다:
- 모든 Mozilla 직원 및 기여자 검토자는 신규 문서 또는 문서 업데이트를 현지화 준비 완료로 표시할 수 있습니다.
- 지역별 가용성에 따라 제품 팀에서 달리 명시하지 않는 한, 새롭거나 변경된 정보를 도입하는 모든 신규 문서 및 수정본은 현지화를 위해 표시되어야 합니다.
- 수정본이 지침, 정확성 또는 사용자 경험을 변경하지 않는 경우, 현지화 우선 순위는 그에 따라 감소해야 합니다.
- 경우에 따라 Mozilla 직원은 특정 로케일에서 내부 현지화를 위해 번역이 이미 제출되고 있음을 나타내기 위해 문서에 주석 구문이나 수정 주석을 남길 수 있습니다. 주석 구문이 문서나 수정본이 이미 내부 현지화를 위해 제출되고 있음을 나타내는 경우, 기여자는 독립적으로 현지화해서는 안 됩니다.
릴리스 준비
예정된 Firefox 정기 릴리스를 지원할 준비가 되었는지 확인하기 위해 릴리스 준비 일정에 대한 몇 가지 지침이 있습니다. 다음 릴리스와 관련된 문서는 다음 릴리스에서 도입된 기능을 다루는 새 문서 또는 콘텐츠 업데이트입니다. 다음 지침은 릴리스 관련 콘텐츠가 있는 문서에 적용됩니다.
Firefox 릴리스 일정
다음 릴리스 4주 전
- 다가오는 릴리스를 위한 콘텐츠 계획 및 초안 작성 시작; 현지화 담당자를 위한 작업은 아직 없습니다.
- 모든 기존 문서는 평소와 같이 편집 및 현지화를 위해 열려 있습니다.
다음 릴리스 1-2주 전
- 다가오는 릴리스를 위한 초안 콘텐츠는 내부적으로 준비될 수 있습니다. 그러나 게시는 일반적으로 막바지 변경 사항을 고려하여 공식 릴리스 날짜까지 기다립니다.
- 콘텐츠가 릴리스 전에 현지화가 필요한 경우, 제품 팀은 CX 직원에게 알려 현지화 커뮤니티와 협력하여 마감일을 맞출 수 있도록 해야 합니다.
릴리스 당일
- 콘텐츠 변경 사항은 en-US 기술 자료에 게시되어야 합니다. 현지화 담당자는 새 릴리스와 관련된 문서 번역을 우선적으로 처리해야 합니다.
토론 채널 및 에스컬레이션
모든 KB 검토자가 KB 토론을 적극적으로 모니터링하는 것은 아닙니다. 전체 KB 검토자 그룹에 연락해야 하는 경우 kb-reviewers@mozilla.com으로 이메일을 보내주세요.
역할 평가
정확하고 일관되며 관련성 있는 콘텐츠를 만드는 것은 중요하며, 시간이 지나도 그 품질을 유지하려면 공유된 표준과 지속적인 조율이 필요합니다.
기술 자료 검토자로서 귀하는 이러한 표준을 유지하는 데 중요한 역할을 합니다. 검토자 그룹이 활발하게 활동하고 현재 관행과 일치하도록 하기 위해 커뮤니티 팀은 참여 및 지침 준수를 기반으로 가벼운 연례 검토를 실시합니다.
KB 검토자 권한을 유지하려면 다음을 요청합니다:
- 조율 유지: 커뮤니티 참여 지침과 이 문서에 설명된 KB 검토자 지침을 준수하세요.
- 활동 유지: 6개월 이내에 최소 3개의 수정본을 검토하세요.
활동하지 않았거나 지침 준수에 대한 질문이 발생하는 경우, 커뮤니티 팀은 조치를 취하기 전에 확인을 위해 귀하에게 연락할 수 있습니다. 우리의 목표는 권한을 제거하는 것이 아니라 검토자가 참여하고 지원받으며 현재 프로세스와 조화를 이루고 있다고 느끼도록 하는 것입니다.
상황이 바뀌어 물러나야 한다면, 저희는 전적으로 이해합니다. 이것은 자원 봉사 역할이므로 시간과 가용성이 자연스럽게 바뀔 수 있습니다. 그런 일이 발생하면 주저하지 말고 커뮤니티 팀에 알려주세요. 다시 참여할 준비가 되면 언제든지 다시 연결해 드리겠습니다.
—
함께 일하고 검토 및 승인 과정에 다른 사람들을 참여시킴으로써 우리는 최고 수준의 품질을 유지하고 콘텐츠가 최고 수준임을 보장할 수 있습니다. 협조해 주셔서 감사하며, 사용자를 위해 계속해서 놀라운 수정본을 만들어 갑시다!