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 Google Phần Tài liệu.
Tóm tắt dự án
- Tổ chức nguồn mở:
- Quan trọng nhất
- Người viết nội dung kỹ thuật:
- @anindita_basu
- Tên dự án:
- Xem lại và tinh chỉnh văn bản trong sản phẩm
- Thời lượng dự án:
- Sử dụng lâu dài (5 tháng)
Mô tả dự án
Tôi tham gia kênh Slack và gửi vài câu hỏi cho Eric. Dựa trên
câu trả lời của anh ấy (cảm ơn Eric!), Tôi đề xuất tiếp cận dự án này theo
theo cách sau:
Phân loại các chuỗi
Tôi sẽ bắt đầu bằng việc xác định chuỗi nào (https://github.com/mattermost/mattermost-webapp/blob/master/i18n/en.json) là chuỗi trong bảng điều khiển hệ thống và chuỗi nào dành cho người dùng. Tôi đề xuất đưa các chuỗi mà người dùng thấy được trước tiên.
Tạo hướng dẫn quy tắc cho các chuỗi
Tôi muốn xác định kiểu viết hoa, độ dài và cách sử dụng từ cho các chuỗi được dùng trong các mục trong trình đơn, nút hành động, nhãn, tiêu đề, chú giải công cụ, lỗi, cảnh báo, xác thực, thông báo và xác nhận (xem ví dụ về ảnh chụp màn hình styleguide tại https://github.com/AninditaBasu/AninditaBasu.github.io/blob/master/gsod/Capture7.PNG). Ngoài ra, tôi muốn tạo một số hướng dẫn về việc sử dụng mã thông báo (phần giữ chỗ) trong các chuỗi, đặc biệt là chuỗi tổng hợp.
Tôi dự định trình bày hướng dẫn này vào một trang của trang tính khổ A4, ngắn hơn nếu có thể. Với ý định này, các nhà phát triển thực sự viết các chuỗi này sẽ thấy hướng dẫn nhanh chóng và dễ sử dụng. Ngoài ra, khi làm theo, văn bản giao diện người dùng sẽ thể hiện tính nhất quán trên tất cả các màn hình.
Tôi đề xuất làm điều này vì hai lý do: (a) để có sự nhất quán về văn bản về mặt ngữ pháp và văn phong (b) để ngay cả sau khi GSoD kết thúc, có một bộ hướng dẫn mà bất cứ ai cũng có thể nhanh chóng tham khảo khi viết văn bản giao diện người dùng
Xem lại và tinh chỉnh văn bản
Dựa trên hướng dẫn quy tắc được tạo ở #2, tôi sẽ chỉnh sửa các chuỗi và tạo yêu cầu lấy dữ liệu trên GitHub.
=============
Thời lượng
Tôi chưa biết có bao nhiêu chuỗi là các chuỗi mà người dùng nhìn thấy (tôi đề xuất đưa vào để xem xét trong dự án này). Tôi ước tính việc tạo hướng dẫn quy tắc sẽ mất khoảng 3 tuần (từ bản nháp đến lúc phê duyệt) và công việc này có thể được thực hiện đồng thời với việc phân loại các chuỗi dưới dạng chuỗi hệ thống hoặc mà người dùng sẽ thấy. Tôi đề xuất bắt đầu với giả định rằng dự án sẽ là một dự án có độ dài tiêu chuẩn (3 tháng), trong đó tôi chỉ xem xét nhiều chuỗi nhất có thể trong khung thời gian này.
Vì hiện đang làm việc toàn thời gian nên tôi chỉ có thể làm một phần trong ngày cho dự án này. Nếu bạn cho rằng số giờ làm việc giảm bớt của tôi là cần thiết, thì tôi sẵn sàng thực hiện một dự án có thời lượng dài hơn.