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ở:
- Mattermost
- 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à gửi một số câu hỏi cho Eric. Dựa trên
phản hồi của anh ấy (cảm ơn Eric!), Tôi đề xuất phương pháp 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 cách xác định những chuỗi (https://github.com/mattermost/mattermost-webapp/blob/master/i18n/en.json) là chuỗi bảng điều khiển hệ thống và những chuỗi nào là chuỗi giao diện người dùng. Trước tiên, tôi đề xuất xem xét các chuỗi mà người dùng nhìn thấy.
Tạo hướng dẫn kiểu cho chuỗi
Tôi muốn xác định kiểu chữ 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 ảnh chụp màn hình hướng dẫn kiểu ví dụ tại https://github.com/AninditaBasu/AninditaBasu.github.io/blob/master/gsod/Capture7.PNG). Ngoài ra, tôi muốn đưa ra một số hướng dẫn về cách sử dụng mã thông báo (phần giữ chỗ) trong chuỗi, đặc biệt là chuỗi kết hợp.
Tôi sẽ cố gắng giữ hướng dẫn này trong một trang có kích thước A4, ngắn hơn nếu có thể. Ý định là 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 được làm theo, văn bản giao diện người dùng sẽ cho thấy 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ó tính nhất quán về mặt ngữ pháp và văn phong trong 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ể nhanh chóng tham khảo khi viết văn bản giao diện người dùng
Xem xét và tinh chỉnh văn bản
Dựa trên hướng dẫn quy tắc được tạo ở bước 2, tôi sẽ chỉnh sửa các chuỗi và tạo yêu cầu kéo trên GitHub.
=============
Thời lượng
Tôi chưa biết có bao nhiêu chuỗi là chuỗi dành cho người dùng (đây là những gì tôi đề xuất xem xét trong dự án này). Tôi ước tính rằng việc tạo hướng dẫn quy tắc lập trình sẽ mất khoảng 3 tuần (từ bản nháp đến khi phê duyệt). Bạn có thể thực hiện công việc này đồng thời với việc phân loại chuỗi dưới dạng chuỗi hệ thống hoặc chuỗi giao diện người dùng. Tôi đề xuất bắt đầu với giả định rằng dự án sẽ có thời lượng tiêu chuẩn (3 tháng), trong đó tôi chỉ xem xét một số lượng chuỗi nhất định trong khung thời gian này.
Vì đã có công việc toàn thời gian nên tôi chỉ có thể làm việc một phần thời gian trong ngày cho dự án này. Tôi sẵn sàng làm việc với một dự án có thời hạn dài hơn nếu bạn cho rằng tôi cần làm việc nhiều giờ hơn.