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ở:
- WordPress
- Người viết nội dung kỹ thuật:
- âm thanh
- Tên dự án:
- Bộ hướng dẫn về văn phong cho tài liệu đã được gia hạn và đầy đủ
- Thời lượng dự án:
- Lâu dài (5 tháng)
Mô tả dự án
Bản tóm tắt:
WordPress là một tổ chức phần mềm phi lợi nhuận toàn cầu chuyên phục vụ các cộng đồng toàn cầu bằng phần mềm chú trọng vào khả năng hỗ trợ tiếp cận, hiệu suất, tính bảo mật và tính dễ sử dụng. Sự nghiệp của WordPress cố gắng dân chủ hoá việc xuất bản và phần mềm nguồn mở trên web. Trong thời đại kỹ thuật số của chúng ta, trang web hoàn toàn là mặt tiền trực tuyến của một tổ chức/cá nhân; và WordPress phục vụ một nhiệm vụ to lớn là phục vụ hiệu quả hàng trăm triệu người dùng – được coi là đóng góp 35% lượng Internet mà nó chạy trên đó – bằng phần mềm của họ. Để phục vụ những người dùng này hiệu quả hơn nữa, tài liệu là yếu tố cần thiết và được hầu hết các nhà phát triển, quản trị viên và người dùng cuối sử dụng. Do đó, tài liệu có thể được thiết lập làm yếu tố chính của hệ sinh thái WordPress. Tài liệu WordPress hiện tại không có bộ quy tắc thống nhất và bộ quy tắc chung cũng như nguyên tắc về kiểu để xuất bản. Mục đích của đề xuất này là tạo ra một bộ nguyên tắc đầy đủ và đổi mới về kiểu tài liệu, áp dụng cho toàn bộ tài liệu của WordPress. Ý tưởng dự án bao gồm việc tổng hợp tất cả các khía cạnh của nguyên tắc thiết kế và kiểu như về ngữ nghĩa, cú pháp, nguyên tắc ngữ pháp, dấu câu, quy tắc dành riêng cho quá trình phát triển, thuộc tính thiết kế và các chi tiết cụ thể về định dạng. Những ngôn ngữ này cũng kết hợp các quy ước ngôn ngữ như giọng nói, tông điệu, thì của từ, tất cả các thành phần của lời nói, cũng như quy ước đặt tên. Các công cụ, ngôn ngữ và nền tảng được sử dụng sẽ là WordPress CMS, GitHub, Markdown và cũng có thể bao gồm PHP/MySQL, HTML/CSS và JavaScript.
Kế hoạch dự án:
Trạng thái hiện tại của Hướng dẫn về kiểu tài liệu WordPress: Nhóm tài liệu WordPress đang triển khai một phương pháp chưa khai báo nhưng nhất quán về phương pháp nguyên tắc xuất bản. Tuy nhiên, đôi khi, một số yếu tố được giả định trước và quá trình này trở thành suy đoán. Không có tiêu chuẩn và tiêu chí cố định nào cho mục đích viết và xuất bản bài viết dành cho WordPress. Nhóm tài liệu đã viết nguyên tắc về quy tắc dành riêng cho dự án, nhưng không có nguyên tắc nào áp dụng cho toàn cầu. Hầu hết các nguyên tắc về kiểu hiện có không được tổng hợp trong một sổ tay hoặc sẽ không được dùng nữa và cần được cập nhật. Do đó, bạn cần thiết kế và phát triển một hướng dẫn quy tắc thống nhất để chuẩn hoá tài liệu WordPress.
Mục tiêu:
Hơn 35% trang web trên Internet chạy trên WordPress, điều này cho thấy hàng triệu nhà phát triển và người dùng cuối đang sử dụng các chức năng ấn tượng của WordPress. Tài liệu là yếu tố thiết yếu trong việc hỗ trợ các nhà phát triển và người dùng này thực hiện các chức năng này một cách hiệu quả mà không gặp bất kỳ rắc rối nào, ngay cả trong trường hợp bất tiện. Mục tiêu tổng thể của đề xuất dự án này là chuẩn hoá hướng dẫn về thiết kế và kiểu, hợp nhất các hướng dẫn về kiểu hiện có và cập nhật, cũng như bổ sung các quy định và thông số kỹ thuật mới cho tài liệu của WordPress. Điều này sẽ giúp dễ sử dụng, đơn giản và thống nhất trong tài liệu WordPress.
Cách triển khai:
Theo gợi ý của cố vấn (Jon Ang) cho dự án này, dự án có thể được tiếp cận theo 4 giai đoạn: giai đoạn Khám phá, Định nghĩa, Triển khai và Bảo trì. Trước khi bắt đầu dự án, trong giai đoạn trước khi thực tập, tôi sẽ làm việc với người cố vấn và hoàn thiện lịch trình cũng như tiến trình phù hợp theo các dòng thời gian và sản phẩm tiếp theo của tôi. Tôi sẽ tìm hiểu thêm về hệ thống WordPress và các giao thức làm việc cho dự án này.
Khi chương trình thực tập bắt đầu, tôi sẽ thảo luận và soạn thảo tóm tắt của kế hoạch với người cố vấn của mình. Các yêu cầu và sự cần thiết sẽ được xác định. Đầu tiên, tôi sẽ trình bày về quy trình tài liệu và quy trình tương tác của người dùng. Sau đó, khung dây bố cục của từng phần, danh mục và thành phần sẽ được vẽ đường viền. Sau đó, cố vấn của tôi sẽ xem xét những bố cục này. Nếu cần, bố cục sẽ được thiết kế lại và một số thành phần được thêm/xoá. Sau đó, tôi sẽ tiến hành nghiên cứu về người dùng để xác định khả năng hữu dụng và tính khả thi của luồng giao diện. Sau đó, Hướng dẫn về kiểu tài liệu sẽ được triển khai (như minh hoạ trong sơ đồ bên dưới) cho từng phần. Bạn cũng có thể tham khảo hướng dẫn về văn phong của các tổ chức khác thuộc bất kỳ nguồn mở hoặc giấy phép Creative Commons nào để bổ sung hướng dẫn của chúng tôi. Nếu xảy ra bất kỳ khó khăn nào về khả năng sử dụng trong khoảng thời gian này, tôi sẽ thiết kế lại chúng.
Quá trình thử nghiệm và tối ưu hoá sẽ được thực hiện sau khi hoàn tất hướng dẫn quy tắc và tích hợp với HelpHub. Mọi lỗ hổng, phần tử hoặc thành phần dư thừa đều sẽ được khắc phục. Quá trình kiểm thử giao diện người dùng và mã sẽ được tiến hành, đồng thời sẽ khắc phục các lỗi và lỗi không mong muốn (nếu cần). Chúng tôi sẽ kiểm soát chất lượng cuối cùng đối với hướng dẫn quy định hoàn chỉnh về ngôn ngữ, ngữ pháp, chính tả, dấu câu, v.v.
Những tác vụ đang chờ xử lý do sự chậm trễ ngoài dự kiến sẽ được hoàn tất trong khoảng thời gian chờ. Các chức năng hoặc tính năng bổ sung được xác định là khả thi trong suốt quá trình dự án có thể được triển khai sau khi hoàn thành bước kiểm thử cuối cùng. Kế hoạch triển khai sẽ được xây dựng và sản phẩm hoàn thiện sẽ được gửi.
Công cụ và phương pháp:
Tài liệu sẽ được biên soạn và chỉnh sửa trên một nền tảng cộng tác, chẳng hạn như Google Tài liệu. Nếu bắt buộc phải phát hành qua GitHub, bạn cũng có thể triển khai các ngôn ngữ đánh dấu như Markdown hoặc GitHub Flavored Markdown. Đối với các tiêu chuẩn về thiết kế và kiểu dáng, bạn cũng có thể tham khảo nguyên tắc về kiểu nguồn mở. Cuối cùng, tài liệu hoàn chỉnh sẽ được định dạng và xuất bản bằng WordPress.
Bảng thành phần:
Đây là danh sách đầy đủ các thành phần có thể triển khai trong Hướng dẫn về quy tắc lập trình. Nguyên tắc về tài liệu – Hỗ trợ tiếp cận, Cấu trúc tài liệu, Mã hoá, Nguồn bên ngoài, Sự kiện, Phông chữ, Khán giả toàn cầu, Tính hoà nhập, Tính hợp pháp, Hỗ trợ tiếp cận đa nền tảng, Không mơ hồ, Không có tuyên bố quá mức, Bố cục trang, Chỉnh sửa chính trị, Giao thức, Bảo mật, Cấu trúc câu, Viết câu súc tích, Giọng điệu và phong cách, Không thiên vị
Ngôn ngữ và ngữ pháp – Từ viết tắt và từ viết tắt, Khẳng định & Phủ định, Bài viết, Viết hoa, Mệnh đề, Lời nói trực tiếp/gián tiếp, ngôi thứ nhất/thứ hai/thứ ba, Giới tính, Bảng chú giải thuật ngữ, Danh từ, Tiền tố và hậu tố, Giới từ, Đại từ nhân xưng, Giới thiệu, Tiếng lóng & biệt ngữ, Chính tả, Thuật ngữ kỹ thuật, Thì từ, Tiếng lóng, Giọng nói
Dấu câu – Dấu nháy đơn & Dấu ngoặc kép, Dấu hai chấm & Nửa dấu chấm, Dấu phẩy, Dấu ba chấm, Dấu chấm than, Dấu gạch nối & Dấu gạch ngang, Dấu ngoặc đơn, Dấu chấm, Dấu chấm hỏi, Dấu gạch chéo
Định dạng – Tóm tắt, Giới thiệu, Lời nói đầu, Tên thương hiệu, Tên sản phẩm, Chú thích, Đoạn mã, Đoạn mã, Khối mã, Ngày và giờ, Múi giờ, Địa điểm, Đơn vị tiền tệ, Tên tệp, Chú thích cuối trang, Tiêu đề và Tiêu đề, Đánh dấu (In đậm, In nghiêng, Gạch dưới, Dấu gạch ngang, Dấu đầu dòng, Dấu đầu dòng, Video Cảnh báo, Số đo và Mã số điện thoại, Mã số và Mã số, Ngày và Giờ, Múi giờ, Địa điểm, Đơn vị tiền tệ, Tên tệp, Chú thích cuối trang, Tiêu đề và Tiêu đề, Đánh dấu (In đậm, In nghiêng, Gạch dưới, Dấu gạch ngang, Dấu đầu dòng), Dấu đầu dòng, Video cảnh báo, Đường liên kết & URL, Danh sách, Hình ảnh minh hoạ, Dấu đầu dòng, Chỉ mục
Giao diện người dùng – Hoạt động, Nút, Đoạn mã, Khối mã, Giao diện dòng lệnh, Hộp thoại, Trình đơn và trình đơn thả xuống, Cửa sổ bật lên và cảnh báo, Thẻ, Thuật ngữ, Thành phần giao diện người dùng, Windows
Mã – CSS, HTML, JS, Markdown, MySQL, PHP, Cú pháp, XML
Từ điển/Bảng thuật ngữ sử dụng từ – Từ A đến Z