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ở:
- 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:
- Lâu dài (5 tháng)
Mô tả dự án
Tôi tham gia kênh Slack và trả lời một số 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 dự định tiếp cận dự án này 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 những chuỗi (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 dự định xem xét các chuỗi dành cho người dùng 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 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, quy trình xác thực, thông báo và thông tin xác nhận (xem ảnh chụp màn hình mẫu 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 chuỗi, đặc biệt là chuỗi tổng hợp.
Tôi cố gắng trình bày hướng dẫn này chỉ trên một trang của trang tính có kích thước A4, ngắn hơn nếu có thể. Với mong muốn đó, các nhà phát triển thực sự viết các chuỗi này sẽ tìm 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ẽ hiển thị 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ề ngữ pháp và văn phong trong nội dung văn bản (b) để ngay cả sau khi GSoD kết thúc, vẫn có một bộ hướng dẫn mà bất cứ ai cũng có thể tham khảo nhanh 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 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 dành cho người dùng (đây là những gì 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 cho đến lúc phê duyệt) và bạn có thể thực hiện đồng thời công việc này với việc phân loại các chuỗi dưới dạng chuỗi hệ thống hoặc dành cho người dùng. Tôi đề xuất bắt đầu với việc giả định rằng dự án sẽ là một dự án có thời lượng chuẩn (3 tháng), trong đó tôi chỉ xem xét quá nhiều chuỗi để xem xét hết mức 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 trong dự án này. Tôi sẵn sàng triển khai một dự án dài hơn 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.