이 페이지에는 Google 시즌의 Docs에 승인된 기술 글쓰기 프로젝트의 세부정보가 포함되어 있습니다.
프로젝트 요약
- 오픈소스 조직:
- Mattermost
- 기술 문서 작성자:
- @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개월)의 프로젝트라고 가정하고 이 기간 내에 검토할 수 있는 문자열만 가져옵니다.
저는 이미 정규직으로 근무하고 있으므로 이 프로젝트에 하루 중 일부만 참여할 수 있습니다. 근무 시간이 줄어들면 더 긴 프로젝트를 진행할 수 있습니다.