本頁針對 Google 系列文件接受的技術撰寫專案提供詳細資料。
專案摘要
- 開放原始碼機構：
- 創用 CC
- 技術文件撰寫者：
- JackieBinya
- 專案名稱：
- WordPress 基本主題使用指南
- 專案長度：
- 標準長度 (3 個月)
Project description
在 GSOD-2020 的技術文件撰寫階段中，我曾與 Hugo Solar 互動，他是 Creative Commons WordPress 基礎主題說明文件專案的導師。
初次與他聯絡時，我曾協助瞭解建立 WordPress 基本主題使用指南的目標。他很有幫助，也很快就讓我加入專案。之前，我們結束的所有連續互動，都將改善 CC WordPress 基礎主題說明文件的目標。
進入階段後，我覺得自己瞭解專案的需求和目標，接著就可以為 CC WordPress 基礎主題使用指南製作草擬提案。
此提案是使用實習應用創用 CC 官方範本製作而成。課程內容包括新 WordPress 基礎主題說明文件的專案概要、提議的專案結構和版面配置，以及文件建立階段的時間表和交付項目相關資訊。
接著，Hugo Solar 查看我的提案草稿並提供意見回饋，協助改善這項功能。在這個過程中，他隨時都很樂意回答專案相關問題。
我已根據所提供的意見回饋進行了最終提案，最終提案的提案可透過 Google 文件在下方連結中找到
https://docs.google.com/document/d/1XmIsMTLstbhRRSaNFP538YOXJiS0G5QrN6EzuqJfRy4/edit?usp=sharing
此外，我的提案摘要如下：
創用 CC - WordPress 基本主題使用指南 Jacqueline Binya 於 2020 年 6 月 28 日準備的提案
Project Synopsis 本專案的最終目標是，為 Creative Commons WordPress 基礎主題建立內容豐富、直覺且引人入勝、且賞心悅目的社群文件。
專案計畫 問題 問題 目前創用 WordPress 基礎主題沒有任何說明文件，這麼做可以阻礙社群中有效運用該主題。 我的目標是建立完整的主題使用指南，並在 WP 基本主題目前的程式碼集實作抽象層，讓主題更容易使用。
解決方案 使用 Gatsby 等現代架構建立未來感文件。Gatsby 的啟動條件可啟動新的 WordPress 基礎主題說明文件。舉例來說，「gatsby-gitbook-starter」就是一個立即可用的模型，並支援搜尋引擎最佳化 (SEO)、Markdown 和 Algolia ( 用於整合靜態網站中搜尋的功能)。此外，Gatsby 產生的網站也能輕鬆進行最佳化，以整合國際化和無障礙程度。 建立說明文件時，我的目的是盡量簡化直覺。- - 以簡單明瞭的方式撰寫文件，並留意避免混淆，並避免使用過多複雜的技術術語。 - 將插圖和媒體融入說明文件，做為學習的視覺輔助內容。 - 舉例說明如何執行常見工作，例如自訂項目。
我希望實作的抽象化作業包括確保使用者可以透過 WordPress 管理面板，利用 WP 基礎主題的大部分核心功能，例如執行個體掛鉤。此外，我也想在另一個存放區中建立 WP 基礎主題的入門子項主題。使用新手子主題可為新使用者帶來更順暢快速的新手上路體驗。文件一旦完成並獲得核准，就會發布到線上進行代管。
CC WordPress 基礎主題使用指南的建議架構 - 建議的說明文件將分為下列各節。每個提案部分底下的子清單項目則會詳細說明各部分的實際內容。
總覽專區 - 簡述創用 CC(CC) WordPress 基本主題的定義、意圖和功能。 * 定義：請簡要說明 CC WP 基本主題。 * 意圖：概略說明 CC WP 基本主題的目標/ 意圖 * 功能：概略說明 CC WP 基本主題的功能
入門指南 - 需求 * 概略說明安裝 CC WordPress 基礎主題的規定，例如： - WordPress 版本 - PHP 版本 - Composer 等。 - 安裝指南 * 概述使用者如何使用 ZIP 安裝 CC WordPress 主題 * 從 GitHub 複製 WP 基礎主題，概略說明使用者入門的入門主題。 * 概略說明使用者如何在專案中安裝依附元件。 * 說明使用者如何設定依附元件 Queulat。* 說明使用者如何在本機 WordPress 開發環境中啟用主題。
使用指南 - 總覽 * 說明子主題一詞 * 說明使用子主題的優點。 * 請使用者建議透過子項主題編輯 WP 基本主題。 * 強調使用者必須先安裝並啟用 WP 基準主題，才能製作子主題。
使用子主題 - 說明如何透過啟動條件，建立 WP 基準主題的子主題。 使用影片講解使用者如何從開頭建立子主題。
自訂 在下列子區段中，我們會概略說明使用者如何使用 WordPress 自訂參數和 WordPress 管理面板來自訂內容。此外，我們也會運用圖形插圖，讓說明更加直觀。 - 自訂網站說明或標語。 - 自訂導覽選單 - 自訂 CSS - 新增頁面 - 新增文章 - 小工具 - 從 WordPress 管理面板新增及移除小工具 - 透過即時預覽功能使用自訂參數新增小工具
進階自訂部分 - 自訂 CSS 部分 * 說明構成主題樣式的元件： - CC 詞彙 - Bulma - Sass * 說明 Sass 在專案中設定的方式。說明應包含以下資訊： (i)專案結構中 sass 檔案的位置 (ii) npm 指令碼，可用於建構和監控服務 * 說明使用者如何自訂子主題中的 sass 樣式 (例如安裝特定的 npm 依附元件 * 說明元件類別 (class-component.php) 如何用來自訂特定元件的樣式
- 「掛勾」專區
總覽
- 說明「鉤」一詞
- 說明使用者為何需要利用掛鉤。
- 概略說明可用的掛鉤類型。
使用動作
- 列出 WP 基本主題中可用的動作及其位置
- 說明如何實作這些動作。
*使用篩選器 - 列出主題中可用的篩選器，並解釋如何實作
更新主題區段 - 說明使用者如何更新主題。
授權專區 * 說明專案的授權，以及對個人專案中使用 CC WP 基本主題的使用者有何意義。
貢獻章節 * 新增詳盡的貢獻指南 * 概述行為準則 * 社群：提供創用 CC 社群頻道相關資訊，以及貢獻者參與方式等資訊。