Trang này chứa thông tin chi tiết về một dự án viết nội dung kỹ thuật đã được chấp nhận tham gia Google Season of Docs.
Tóm tắt dự án
- Tổ chức nguồn mở:
- Hiệp hội Wordnet toàn cầu
- Người viết nội dung kỹ thuật:
- Yoyo Wu
- Tên dự án:
- Cấu trúc Wordnet
- Thời lượng dự án:
- Thời hạn tiêu chuẩn (3 tháng)
Mô tả dự án
Lý do của dự án này
Là một nhà văn kỹ thuật chuyên về Ngôn ngữ học, tôi rất vui khi tìm thấy một dự án như vậy, với ý tưởng liên kết các ngôn ngữ khác nhau với nhau bằng một khung khái niệm ngữ nghĩa hợp nhất và đã được áp dụng cho các doanh nghiệp thực tế như Google Dịch. Tôi muốn đóng góp vào tài liệu của dự án này để làm cho dự án thân thiện hơn với đối tượng.
Vấn đề
Tôi đã xem qua tài liệu gốc và cho rằng chúng ta có thể cải thiện tài liệu đó bằng cách giải quyết các vấn đề dưới đây: Thiếu phần Tổng quan ở đầu tài liệu để giới thiệu các kiến thức cơ bản về wordnet, điều này sẽ hữu ích cho người mới. Mặc dù tất cả các quan hệ trong wordnet được triển khai trong một mẫu thống nhất, một số mối quan hệ thiếu thông tin cần thiết, chẳng hạn như các ví dụ và bài kiểm tra, được phân phối trong trang web Wordnet của Ontario, hướng dẫn chung của EuroWordnet và các tài nguyên khác. Định nghĩa và định nghĩa ngắn, Ví dụ ngắn và Ví dụ không có mẫu câu thống nhất, vì định nghĩa ngắn và Ví dụ ngắn là những chú thích khi người dùng di chuột qua mối quan hệ cụ thể đó, Định nghĩa và Ví dụ đóng vai trò chính trong việc giới thiệu mối quan hệ. Do đó, các định nghĩa và Ví dụ phải được cấu trúc thành các mẫu thống nhất nhưng khác với các mẫu ngắn tương ứng. Bài kiểm thử được lấy từ EWN, nhưng khối điều kiện nên được đặt trước nội dung kiểm thử chính, vì người dùng sẽ luôn xem xét các điều kiện trước để quyết định xem dữ liệu ngôn ngữ học của họ có khớp với các điều kiện hay không rồi mới tiến hành kiểm thử. Nội dung kiểm thử cũng không đơn giản với nhiều từ viết tắt về ngôn ngữ. Nội dung của phần Bình luận rất đa dạng, đôi khi nhấn mạnh một điểm cụ thể của định nghĩa, đôi khi nêu chi tiết dành riêng cho dự án. Tôi nghĩ chúng ta nên đặt ra một tiêu chuẩn cho phần này. Việc di chuyển thông tin về các dự án cụ thể sang phần Tên dự án cụ thể sẽ thuận tiện hơn cho người dùng. Phần Tên theo dự án sẽ tóm tắt tên mối quan hệ trong tất cả các dự án. Bạn cần xem xét phần này vì đã xảy ra lỗi không khớp. Cần liên kết trực tiếp Bảng thuật ngữ với tài liệu và thêm tất cả các từ viết tắt và thuật ngữ mà người mới có thể chưa quen.
Nguyên tắc
Tôi cũng muốn thảo luận hai chủ đề dưới đây với nhóm dự án trước khi soạn tài liệu. Kết luận nhận được sẽ là nguyên tắc chung cho toàn bộ dự án.
Về khán giả Đây là một ví dụ thực tế về bản thân tôi, mặc dù tôi là một chuyên gia ngôn ngữ, nhưng khi lần đầu tiên bắt gặp tài liệu gốc, tôi không biết "synset" có nghĩa là gì, vì trên trang web Unity Wordnet, tôi thấy ý nghĩa của từ này.
Vì vậy, trước tiên, chúng ta cần tìm hiểu cấu trúc kiến thức của đối tượng tiềm năng. Nếu không thể đảm bảo tất cả đối tượng đều có kiến thức liên quan, thì ít nhất chúng ta cần thêm phần Tổng quan, liên kết với Bảng thuật ngữ và các tài nguyên liên quan khác để hướng dẫn họ tìm hiểu về wordnet và các dự án liên quan. Chúng ta phải luôn ghi nhớ giả định này trong toàn bộ quá trình ghi chép,
Giới thiệu chức năng của tài liệu Theo hiểu biết của tôi, mục tiêu của tài liệu về cấu trúc wordnet là giúp người dùng làm quen với tất cả các loại quan hệ trong Wordnet và người dùng có thể nhóm các từ vào các quan hệ đó dựa trên thông tin được cung cấp. Tuy nhiên, tài liệu gốc trông giống như trích đoạn của các bài báo học thuật. Nếu mục đích của tài liệu là để tham khảo học thuật thì không sao, nhưng nếu tài liệu đó phục vụ mục tiêu hướng dẫn người dùng, thì phải có sự đánh đổi giữa học thuật và tiện ích.
Lợi ích
Tôi có thể giúp dịch tài liệu sang tiếng Trung. Tôi có kinh nghiệm dịch các bài báo về ngôn ngữ từ tiếng Anh sang tiếng Trung. Tôi có thể giúp định dạng tài liệu, tôi biết kiến thức cơ bản về HTML/CSS và có thể giúp trang web tài liệu trông đẹp hơn, chẳng hạn như thêm thanh điều hướng bên. Tôi có thể giúp vẽ một số sơ đồ quy trình bằng Visio hoặc Mermaid nếu sơ đồ quy trình có thể giúp người dùng hiểu rõ hơn về các mối quan hệ.
Cột mốc / Thời gian / Mục tiêu
- Tuần 1: Thảo luận và thống nhất mục tiêu, quy trình làm việc và kế hoạch làm việc với nhóm dự án.
- Tuần 2: Hoàn thiện bố cục tài liệu và viết phần Tổng quan.
- Tuần 3 – Tuần 4: Viết phần Mối quan hệ cấu trúc.
- Tuần 5 – Tuần 6: Viết phần Quan hệ khác và Quan hệ miền.
- Tuần 7 – Tuần 8: Viết phần Mối quan hệ vai trò.
- Tuần 9: Viết ba mối quan hệ còn lại và cập nhật từ điển.
- Tuần 10: Dịch phiên bản tiếng Trung nếu cần.
- Tuần 11: Sửa đổi định dạng tài liệu.
- Tuần 12: Kiểm tra cuối cùng và tóm tắt dự án này.