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 tài liệu của Google.
Tóm tắt dự án
- Tổ chức nguồn mở:
- Giấy phép Creative Commons
- Người viết nội dung kỹ thuật:
- JackieBinya
- Tên dự án:
- Hướng dẫn sử dụng giao diện cơ bản của WordPress
- Độ dài dự án:
- Thời hạn tiêu chuẩn (3 tháng)
Mô tả dự án
Trong giai đoạn đăng ký tham gia chương trình Nhà văn kỹ thuật của GSOD-2020, tôi đã có một số hoạt động tương tác với Hugo Solar, người cố vấn của dự án tài liệu về giao diện cơ sở WordPress của Creative Commons.
Trong lần đầu tiên liên hệ với anh, tôi đã tìm sự trợ giúp để hiểu rõ mục tiêu của việc tạo hướng dẫn sử dụng giao diện cơ sở WordPress. Anh ấy rất nhiệt tình giúp đỡ và nhanh chóng giúp tôi tham gia dự án. Tất cả các hoạt động tương tác liên tiếp sau đó đều nhằm mục đích tinh chỉnh các mục tiêu của tài liệu về giao diện cơ sở WordPress CC.
Khi đã hiểu rõ các yêu cầu và mục tiêu của dự án, tôi đã tiếp tục tạo bản dự thảo đề xuất cho Hướng dẫn sử dụng giao diện cơ sở WordPress của CC.
Đề xuất này được tạo bằng mẫu chính thức của Creative Commons dành cho đơn đăng ký thực tập. Tài liệu này cung cấp thông tin về bản tóm tắt dự án, cấu trúc dự án được đề xuất và bố cục của tài liệu về giao diện cơ sở WordPress mới, cũng như thông tin về tiến trình và sản phẩm cần hoàn thành cho giai đoạn tạo tài liệu.
Sau đó, Hugo Solar đã xem xét bản đề xuất nháp của tôi và đưa ra ý kiến phản hồi để tôi cải thiện. Trong suốt quá trình này, anh luôn sẵn sàng trả lời các câu hỏi về dự án.
Tôi đã triển khai ý kiến phản hồi và đề xuất cuối cùng của tôi về tài liệu Xây dựng huy hiệu D&I có trong đường liên kết dưới đây dưới dạng Google Tài liệu
https://docs.google.com/document/d/1XmIsMTLstbhRRSaNFP538YOXJiS0G5QrN6EzuqJfRy4/edit?usp=sharing
Ngoài ra, bạn có thể xem thông tin tóm tắt về đề xuất của tôi ở bên dưới:
Creative Commons – Hướng dẫn sử dụng giao diện cơ sở WordPress Đề xuất do Jacqueline Binya chuẩn bị, ngày 28 tháng 6 năm 2020
Tóm tắt dự án Mục tiêu cuối cùng của dự án này là tạo ra tài liệu phong phú, trực quan, hấp dẫn và được trình bày đẹp mắt dành cho cộng đồng về Chủ đề cơ sở WordPress của Creative Commons.
Kế hoạch dự án Vấn đề Hiện tại, giao diện Creative Commons của WordPress Base chưa có tài liệu, điều này chính là một rào cản khiến việc sử dụng giao diện này trong cộng đồng diễn ra một cách hiệu quả. Mục tiêu của tôi là tạo một hướng dẫn sử dụng đầy đủ cho giao diện này, đồng thời triển khai các tính năng trừu tượng trong cơ sở mã hiện tại của giao diện WP Base để giúp bạn dễ dàng sử dụng giao diện hơn.
Giải pháp Tạo tài liệu tương lai bằng các khung hiện đại như Gatsby. Gatsby có các điều kiện khởi động mà chúng ta có thể sử dụng để khai thác tài liệu về Giao diện cơ sở mới của WordPress. Ví dụ về trình khởi động là gatsby-gitbook-starter. Trình khởi động này được tích hợp sẵn tính năng hỗ trợ tối ưu hoá cho công cụ tìm kiếm (SEO), markdown và Algolia ( một công cụ dùng để tích hợp cho tính năng tìm kiếm trong các trang web tĩnh). Ngoài ra, mọi trang web do Gatsby tạo đều có thể được tối ưu hoá một cách dễ dàng để tích hợp khả năng quốc tế hoá và khả năng tiếp cận. Khi tạo tài liệu, tôi muốn tài liệu đó trực quan nhất có thể bằng cách: – viết tài liệu theo cách dễ hiểu và cẩn thận tránh sự mơ hồ cũng như việc sử dụng quá nhiều biệt ngữ kỹ thuật phức tạp. – bằng cách kết hợp hình minh hoạ đồ hoạ và nội dung nghe nhìn vào tài liệu để sử dụng làm công cụ hỗ trợ trực quan cho việc học. – sử dụng các ví dụ minh hoạ cách thực hiện các thao tác phổ biến, chẳng hạn như tuỳ chỉnh.
Các tính năng trừu tượng mà tôi hy vọng sẽ triển khai sẽ bao gồm việc đảm bảo rằng người dùng có thể tận dụng hầu hết chức năng cốt lõi của Giao diện cơ sở WP như các móc, ví dụ: từ Bảng điều khiển quản trị WordPress. Ngoài ra, tôi muốn tạo một giao diện con khởi động cho Giao diện cơ sở WP trong một kho lưu trữ riêng. Việc có một giao diện con khởi động sẽ mang lại trải nghiệm làm quen nhanh chóng và suôn sẻ hơn cho người dùng mới. Sau khi hoàn tất và được phê duyệt, tài liệu sẽ được xuất bản và lưu trữ trực tuyến.
Cấu trúc đề xuất của Hướng dẫn sử dụng giao diện cơ sở WordPress của CC – Tài liệu đề xuất sẽ được chia thành nhiều phần như liệt kê bên dưới. Sau đó, các mục danh sách phụ trong mỗi phần được đề xuất sẽ cung cấp thêm thông tin chi tiết về nội dung thực tế sẽ có trong các phần tương ứng.
Mục Tổng quan – Nêu rõ định nghĩa, ý định và các tính năng của Giao diện cơ sở WordPress Creative Commons(CC). * Định nghĩa: Mô tả ngắn gọn về Giao diện cơ sở CC WP. * Ý định: Nêu rõ mục tiêu/ ý định của Giao diện cơ sở CC WP * Tính năng: Nêu rõ các tính năng của Giao diện cơ sở CC WP
Phần bắt đầu - Yêu cầu * Nêu rõ các yêu cầu để cài đặt Giao diện cơ sở WordPress CC, tức là - Phiên bản WordPress - Phiên bản PHP - Trình soạn nhạc, v.v. - Hướng dẫn cài đặt * Nêu rõ cách người dùng có thể sử dụng tệp zip để cài đặt Giao diện WordPress CC * Nêu rõ cách người dùng có thể bắt đầu bằng cách sao chép giao diện cơ sở WP từ GitHub. * Liệt kê cách người dùng có thể cài đặt các phần phụ thuộc trong dự án. * Giải thích cách người dùng có thể định cấu hình Queulat phần phụ thuộc. * Giải thích cách người dùng có thể kích hoạt giao diện này trong môi trường phát triển WordPress cục bộ của họ.
Hướng dẫn sử dụng - Tổng quan * Giải thích thuật ngữ giao diện con * Nêu ra các lợi ích của việc sử dụng giao diện con. * Thông báo cho người dùng rằng cách đề xuất để chỉnh sửa giao diện WP Base là thông qua Giao diện con. * Nhấn mạnh rằng người dùng phải cài đặt và kích hoạt Giao diện cơ sở WP thì mới có thể tạo giao diện con.
Sử dụng Giao diện con – Giải thích cách người dùng có thể tạo giao diện con của Giao diện cơ sở WP bằng một điều kiện khởi động. Sử dụng video để giải thích cách người dùng có thể tạo giao diện con từ giao diện ban đầu.
Tuỳ chỉnh Trong các mục phụ được liệt kê bên dưới, chúng tôi trình bày cách người dùng có thể sử dụng Trình tuỳ chỉnh WordPress và Bảng điều khiển quản trị WordPress để tuỳ chỉnh. Chúng tôi cũng sẽ sử dụng hình minh hoạ đồ hoạ để nội dung mô tả trở nên trực quan hơn. – Tuỳ chỉnh nội dung mô tả trang web hoặc dòng giới thiệu. – Trình đơn điều hướng tuỳ chỉnh – Tuỳ chỉnh CSS – Thêm trang – Thêm bài đăng – Tiện ích – Thêm và xoá tiện ích khỏi Bảng điều khiển quản trị WordPress – Thêm tiện ích bằng trình tuỳ chỉnh có bản xem trước trực tiếp
Phần tuỳ chỉnh nâng cao - Phần tuỳ chỉnh CSS * Mô tả các thành phần tạo nên kiểu của giao diện: - Từ vựng CC - Bulma - Sass * Giải thích cách thiết lập Sass trong dự án. Nội dung giải thích phải bao gồm thông tin về: (i) Vị trí của các tệp sass trong cấu trúc dự án (ii) Các tập lệnh npm có thể dùng để tạo và theo dõi sass * Giải thích cách người dùng có thể tuỳ chỉnh các kiểu sass trong giao diện con, tức là thông qua việc cài đặt các phần phụ thuộc npm cụ thể * Giải thích cách lớp thành phần (class-component.php) được dùng để tuỳ chỉnh kiểu của các thành phần cụ thể
- Phần móc
Tổng quan
- Giải thích thuật ngữ hook
- Giải thích lý do người dùng cần tận dụng các trình bổ trợ.
- Giới thiệu các loại trình bổ trợ hiện có.
Sử dụng Thao tác
- Liệt kê các thao tác có trong giao diện WP Base và vị trí của các thao tác đó
- Giải thích cách triển khai những thao tác này.
*Sử dụng Bộ lọc – Liệt kê các bộ lọc có sẵn trong giao diện và giải thích cách triển khai các bộ lọc đó
Phần Cập nhật giao diện – Giải thích cách người dùng có thể cập nhật giao diện.
Mục cấp phép * Giải thích việc cấp phép cho dự án và ý nghĩa của việc cấp phép đối với những người có thể muốn sử dụng Giao diện cơ sở CC WP trong các dự án cá nhân của họ.
Phần đóng góp * Thêm hướng dẫn chi tiết về cách đóng góp * Nội dung tóm tắt về Quy tắc ứng xử * Cộng đồng: cung cấp thông tin về các kênh cộng đồng của Creative Commons và cách những người đóng góp có thể tham gia, v.v.