이 페이지에는 Google Season of Docs에서 승인된 테크니컬 라이팅 프로젝트의 세부정보가 포함되어 있습니다.
프로젝트 요약
- 오픈소스 조직:
- 가장 중요
- 테크니컬 라이터:
- @anindita_basu
- 프로젝트 이름:
- 제품 내 텍스트 검토 및 조정
- 프로젝트 기간:
- 장기 실행 (5개월)
Project description
Slack 채널에 가입하고 에릭에게 몇 가지 질문을 던졌습니다. 그의 대답 (에릭, 고마워요)
에 따라 이 프로젝트는 다음과 같은 방식으로
접근할 것을 제안합니다.
문자열 분류
먼저 어떤 문자열 (https://github.com/mattermost/mattermost-webapp/blob/master/i18n/en.json)이 시스템 콘솔 문자열과 사용자에게 표시되는 문자열을 식별하겠습니다. 처음에는 검토를 위해 사용자에게 표시되는 문자열을 사용하는 것이 좋습니다.
문자열의 스타일 가이드 만들기
메뉴 항목, 작업 버튼, 라벨, 제목, 도움말, 오류, 경고, 유효성 검사, 알림, 확인에 사용되는 문자열의 대소문자, 길이, 단어 사용 스타일을 정의하려고 합니다 (https://github.com/AninditaBasu/AninditaBasu.github.io/blob/master/gsod/Capture7.PNG에서 스타일 가이드 스크린샷 예시 참고). 또한 문자열, 특히 복합 문자열에서 토큰 (자리표시자)을 사용하는 방법에 대해 안내해 드리겠습니다.
가능하면 A4 크기의 시트에서 한 페이지 분량의 가이드를 짧게 작성하겠습니다. 의도대로, 이러한 문자열을 실제로 작성하는 개발자는 안내를 빠르고 사용하기 쉽도록 해야 합니다. 또한 안내를 따를 경우 UI 텍스트가 모든 화면에서 일관성을 표시해야 합니다.
다음 두 가지 이유로 이렇게 할 것을 제안합니다. (a) 문법과 스타일 면에서 텍스트의 일관성이 중요하기 위해 (b) GSoD가 종료된 후에도 사용자가 UI 텍스트를 작성할 때 빠르게 참조할 수 있는 일련의 안내가 있어야 합니다.
텍스트 검토 및 다듬기
2번에서 만든 스타일 가이드에 따라 GitHub에서 문자열을 수정하고 pull 요청을 만들어 보겠습니다.
=============
시간
나는 아직 몇 개의 문자열이 사용자 대상 문자열 (이 프로젝트에서 검토를 위해)인지 모릅니다. 스타일 가이드를 만드는 데에는 (초안부터 승인까지) 약 3주가 걸릴 것으로 예상되며, 문자열을 시스템 문자열 또는 사용자 대상 분류로 분류하는 작업과 동시에 이 작업을 수행할 수 있습니다. 우선 프로젝트가 표준 길이 (3개월) 프로젝트라고 가정하고 이 기간 동안 가능한 한 많은 문자열만 검토하도록 하겠습니다.
저는 이미 정규직 일을 했기 때문에 하루 중 일부만 이 프로젝트를 진행할 수 있었습니다. 단축된 근무 시간이 필요할 것으로 생각된다면 더 오랜 기간 프로젝트를 진행해도 될지 여쭤봐도 될까요?