Dự án Creative Commons

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ở:
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ơ sở của WordPress
Thời lượng dự án:
Thời gian tiêu chuẩn (3 tháng)

Mô tả dự án

Trong giai đoạn đăng ký tham gia chương trình kỹ thuật dành cho nhà viết của GSOD-2020, tôi đã có một số lần tương tác với Hugo Solar, người cố vấn cho dự án tài liệu về chủ đề cơ sở của Creative Commons trên WordPress.

Trong lần liên hệ đầu tiên với anh ấy, tôi đã tìm kiếm trợ giúp để hiểu 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 hữu ích và nhanh chóng giúp tôi bắt tay vào dự án. Tất cả lượt tương tác liên tiếp mà chúng tôi có được sau đó xoay quanh việc điều chỉnh mục tiêu của tài liệu về chủ đề CC WordPress Base.

Khi đạt đến một giai đoạn, tôi cảm thấy mình hiểu rõ các yêu cầu và mục tiêu của dự án. Sau đó, tôi tiếp tục tạo một đề xuất nháp cho Hướng dẫn sử dụng giao diện cơ sở CC WordPress.

Bản đề xuất được tạo bằng mẫu chính thức của Creative Commons cho đơn đăng ký thực tập sinh. Trang 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ở mới của WordPress, cũng như thông tin về tiến trình và sản phẩm/dịch vụ trong giai đoạn tạo tài liệu.

Sau đó, Hugo Solar đã xem xét bản đề xuất dự thảo của tôi và đưa ra ý kiến phản hồi để cải thiện. Trong suốt quá trình này, anh luôn có mặt để trả lời các câu hỏi về dự án.

Tôi đã triển khai ý kiến phản hồi mà chúng tôi đưa ra và bản đề xuất cuối cùng của tôi liên quan đến Tài liệu về Huy hiệu và việc xây dựng huy hiệu có trong Google Tài liệu thông qua đường liên kết dưới đây

https://docs.google.com/document/d/1XmIsMTLstbhRRSaNFP538YOXJiS0G5QrN6EzuqJfRy4/edit?usp=sharing

Mặt khác, bản tóm tắt ngắn gọn về đề xuất của tôi có ở bên dưới:

Creative Commons – Hướng dẫn sử dụng giao diện cơ sở của WordPress Một bản đề 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 sau 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 đối với Giao diện cơ sở Creative Commons trên WordPress.

Kế hoạch dự án Vấn đề Hiện tại, giao diện cơ sở của Creative Commons trên WordPress vẫn chưa có tài liệu. Đây chính là rào cản cho việc sử dụng hiệu quả giao diện này trong cộng đồng. Mục tiêu của tôi là tạo hướng dẫn sử dụng đầy đủ cho giao diện này, đồng thời triển khai các yếu tố trừu tượng trong cơ sở mã hiện tại của giao diện WP Base để giúp bạn dễ sử dụng giao diện này hơn.

Giải pháp Tạo tài liệu mang tính tương lai bằng cách sử dụng các khung hiện đại như Gatsby. Gatsby có các trình khởi động mà chúng ta có thể sử dụng để khởi động tài liệu về Giao diện cơ sở mới của WordPress. Ví dụ như gatsby-gitbook-starter có khả 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 tính năng tìm kiếm trong các trang web tĩnh). Ngoài ra, bất kỳ trang web nào do Gatsby tạo ra cũng có thể dễ dàng được tối ưu hoá để 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 làm cho 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ự không rõ ràng và sử dụng thuật ngữ kỹ thuật phức tạp quá mức. – bằng cách kết hợp hình ảnh và nội dung nghe nhìn vào tài liệu để sử dụng làm phương tiện hỗ trợ trực quan cho việc học tập. – sử dụng các ví dụ minh hoạ cách thực thi các thao tác phổ biến, ví dụ: tuỳ chỉnh.

Những ý tưởng trừu tượng mà tôi hy vọng sẽ triển khai sẽ đảm bảo rằng người dùng có thể tận dụng hầu hết các chức năng cốt lõi của Giao diện cơ sở WP, chẳng hạn như hook trong Bảng điều khiển quản trị của WordPress. Ngoài ra, tôi rất muốn tạo giao diện con khởi đầu cho Giao diện cơ sở WP trong một kho lưu trữ riêng. Việc triển khai giao diện trẻ em ban đầu sẽ giúp người dùng mới có trải nghiệm làm quen với ứng dụng dễ dàng và nhanh chóng hơn. Khi tài liệu đã hoàn chỉnh 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ở CC WordPress – Tài liệu được đề xuất sẽ được chia thành các phần khác nhau được liệt kê bên dưới. Sau đó, các mục trong 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 đó.

Phần Tổng quan – Trình bày định nghĩa, ý định và tính năng của Giao diện cơ sở WordPress theo giấy phép Creative Commons(CC). * Định nghĩa: Mô tả ngắn gọn Chủ đề cơ sở CC WP. * Ý định: Phác thảo mục đích/ ý định của Giao diện cơ sở CC WP * Tính năng: Phác thảo các đặc điểm của Giao diện cơ sở CC WP

Phần bắt đầu – Yêu cầu * Nêu các yêu cầu để cài đặt Giao diện cơ sở CC WordPress, ví dụ: – Phiên bản WordPress – Phiên bản PHP – Composer, v.v. – Hướng dẫn cài đặt * Phác thảo cách người dùng có thể sử dụng zip để cài đặt CC WordPress Theme * Phác thảo cách người dùng có thể bắt đầu bằng cách sao chép chủ đề cơ sở WP từ GitHub. * Phác thảo 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 phần phụ thuộc Queulat. * Giải thích cách người dùng có thể kích hoạt giao diện trong môi trường phát triển WordPress tại địa phương.

Hướng dẫn sử dụng – Tổng quan * Giải thích thuật ngữ giao diện con * Nêu các ưu điểm của việc sử dụng giao diện con. * Thông báo cho người dùng rằng bạn nên chỉnh sửa giao diện WP Base thông qua Giao diện con. * Nêu bật thực tế là WP Base Theme phải được cài đặt và kích hoạt trước khi người dùng 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 đ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 ngay từ đầu.

Tuỳ chỉnh Trong các phần phụ được liệt kê bên dưới, chúng tôi phác thảo cách người dùng có thể sử dụng Tùy biến WordPress và Bảng điều khiển quản trị WordPress để tuỳ chỉnh. Chúng tôi cũng sẽ kết hợp việc sử dụng hình ảnh minh hoạ để làm cho phần mô tả trực quan hơn. - Tuỳ chỉnh nội dung mô tả trang web hoặc dòng thẻ. – 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ị của WordPress – Thêm tiện ích bằng Trình tuỳ chỉnh với bản xem trước trực tiếp

Phần Tuỳ chỉnh nâng cao – Tuỳ chỉnh phần CSS * Mô tả các thành phần tạo thành 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. Phần giải thích nên 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à xem 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, chẳng hạn như thông qua việc cài đặt các phần phụ thuộc npm cụ thể * Giải thích cách sử dụng lớp thành phần (class-component.php) để 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ữ hấp dẫn
    • Giải thích lý do người dùng cần tận dụng hook.
    • Phác thảo các loại hook có sẵn.

  • Sử dụng thao tác

    • Liệt kê các thao tác có sẵn trong giao diện WP Base và vị trí của giao diện
    • 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ó trong giao diện và giải thích cách triển khai các bộ lọc đó

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 của dự án và ý nghĩa của việc cấp phép đó đối với những người muốn sử dụng CC WP Base Theme trong dự án cá nhân.

Phần đóng góp * Thêm hướng dẫn đóng góp chi tiết * Nêu rõ Quy tắc ứng xử * Cộng đồng: cung cấp thông tin về các kênh cộng đồng Creative Commons và cách cộng tác viên có thể tham gia, v.v.