이 페이지에는 Google Season of Docs에서 승인된 테크니컬 라이팅 프로젝트의 세부정보가 포함되어 있습니다.
프로젝트 요약
- 오픈소스 조직:
- 글로벌 Wordnet 협회
- 테크니컬 라이터:
- 요요 우
- 프로젝트 이름:
- Wordnet 구조
- 프로젝트 기간:
- 표준 기간 (3개월)
Project description
이 프로젝트의 이유
저는 언어학을 전공하는 테크니컬 라이터로서, 다양한 언어를 통합된 의미론적 프레임워크와 연결하여 다양한 언어를 연결한다는 아이디어를 가지고 이러한 프로젝트를 찾아 나서서 Google 번역과 같은 현실 세계에 적용되었죠. 청중이 더 사용자 친화적 일 수 있도록 이 프로젝트의 문서에 기여하고 싶습니다.
문제
원본 문서를 검토했으며 다음 문제를 해결하여 개선할 수 있을 것 같습니다. 시작 부분에는 초보자에게 도움이 되는 Wordnet의 기본사항을 소개하는 개요 섹션이 없습니다. 워드넷의 모든 관계가 통합 템플릿으로 배포되기는 하지만 일부 관계에는 프린스턴 워드넷 웹페이지, EuroWordnet 일반 가이드라인 및 기타 리소스에 배포되어 있는 예시 및 테스트와 같은 필수 정보가 부족합니다. 짧은 정의 및 짧은 예시와 예시에는 통일된 문장 패턴이 없습니다. 사용자가 특정 관계 위로 마우스를 가져가면 콜아웃이 짧은 정의와 짧은 예시가 되기 때문에, 정의와 예시는 관계를 소개하는 기본 역할을 합니다. 짧은 정의와 다른 패턴으로 통합되어야 합니다. 테스트는 EWN에서 도출되지만, 사용자는 항상 조건을 먼저 보고 언어 데이터가 조건과 일치하는지 판단한 다음 테스트에 응시하기 때문에 기본 테스트 본문에 조건 블록이 배치되어야 합니다. 테스트 본문 역시 많은 언어 약어로 복잡하지 않습니다. 댓글 섹션의 내용은 다양하며, 정의의 특정 포인트를 강조하거나 프로젝트별 세부정보를 명시하기도 합니다. 이 섹션의 표준을 정해야 한다고 생각합니다. 특정 프로젝트에 대한 정보를 프로젝트별 이름 섹션으로 이동하면 사용자가 더 편리할 것입니다. 프로젝트별 이름 섹션에는 모든 프로젝트의 관계 이름이 요약되어 있습니다. 불일치 오류가 발생하므로 이 섹션을 검토해야 합니다. 용어집을 문서에 직접 링크하고 초보자가 익숙하지 않을 수 있는 약어와 용어를 모두 추가해야 합니다.
가이드라인
또한 문서의 초안을 작성하기 전에 프로젝트 팀과 아래의 두 가지 주제를 논의하고자 합니다. 받은 결론은 전체 프로젝트에 대한 일반적인 가이드라인이 됩니다.
독자에 대한 정보 제가 언어학 전공이지만 원본 문서를 처음 접했을 때 'synset'이 무슨 뜻인지 모르겠어요. 프린스턴 워드넷 웹페이지에서 synset의 의미를 알게 되죠.
따라서 먼저 잠재 잠재고객의 지식 구조를 파악해야 합니다. 모든 잠재고객이 관련 지식을 갖추었는지 확인할 수 없는 경우 최소한 개요 섹션을 추가하고 용어집과 기타 관련 리소스를 연결하여 워드넷 및 관련 프로젝트를 통해 안내할 수 있습니다. 전체 문서화 프로세스 중에 항상 이러한 가정을 염두에 두어야 합니다.
문서 기능 정보 제가 아는 바에 따르면, 워드넷 구조 문서의 목표는 사용자가 워드넷의 모든 관계 유형에 익숙해지도록 돕는 것이며, 사용자는 제공된 정보를 기반으로 단어를 해당 관계로 그룹화할 수 있습니다. 하지만 원본 문서는 학술 논문 발췌문과 비슷해 보입니다. 문서의 목적이 학술적 참고용이라면 괜찮습니다. 하지만 사용자를 안내한다는 목표에 부합한다면 학계와 유용성 사이에 절충점이 있어야 합니다.
이점
문서의 중국어 버전 번역을 도와드릴 수 있습니다. 영어에서 중국어로 언어 논문을 번역한 경험이 있습니다. 문서의 형식을 지정하는 데 도움을 드릴 수 있습니다. HTML/CSS에 관한 기본사항을 알고 있으며, 측면 탐색 메뉴를 추가하는 등 문서 웹페이지를 더 멋지게 만드는 데 도움을 드릴 수 있습니다. 사용자가 관계를 더 잘 이해하는 데 도움이 된다면 Visio 또는 머메이드를 사용하여 플로우 차트를 그리도록 도와드릴 수 있습니다.
마일스톤 / 시간 / 목표
- 1주 차: 프로젝트팀과 목표, 워크플로, 작업 계획에 대해 논의하고 협의합니다.
- 2주 차: 문서 개요를 확정하고 개요 섹션을 작성합니다.
- 3주 차 – 4주 차: 구성 관계 부분을 작성합니다.
- 5~6주 차: 기타 관계와 도메인 관계 부분을 작성합니다.
- 7주 차~8주 차: 역할 관계 부분을 작성합니다.
- 9주 차: 나머지 관계 세 개를 작성하고 용어집을 업데이트합니다.
- 10주 차: 필요한 경우 중국어 버전을 번역합니다.
- 11주 차: 문서의 형식을 수정합니다.
- 12주 차: 프로젝트를 최종 점검하고 요약합니다.