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