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