本頁面包含 Google 技術文件季度接受的技術寫作專案詳細資料。
專案摘要
- 開放原始碼組織：
- WordPress
- 技術撰稿人：
- tacitonic
- 專案名稱：
- 完整且更新的說明文件格式指南
- 專案長度：
- 長時間跑步 (5 個月)
Project description
概要：
WordPress 是全球非營利軟體組織，致力於為全球社群提供強調無障礙、效能、安全性和易用性的軟體。WordPress 正致力讓網路上的發布和開放原始碼軟體變得更普及。在數位時代，網站是組織/個人在網路上的門面，而 WordPress 則是負責這項任務，透過其軟體為 35% 的網路使用者提供服務。為了更有效為這些使用者提供服務，說明文件確實至關重要，而且大部分開發人員、管理員和使用者都能運用說明文件。因此，說明文件可以成為 WordPress 生態系統的主要因素。目前的 WordPress 說明文件並未包含通用的統一通用規則和樣式規範，本提案的動機是建立一套完整且更新的說明文件樣式指南，適用於 WordPress 說明文件。專案構想包含整合設計和樣式規範的各個層面，例如語意、語法、文法規範、標點符號、開發專屬規則、設計屬性和格式細節。它還納入語言慣例，例如語氣、語調、時態、所有詞性，以及命名慣例。工具、語言和平台為 WordPress CMS、GitHub、Markdown，也可能包含 PHP/MySQL、HTML/CSS 和 JavaScript。
專案計畫：
WordPress 說明文件風格指南的現況：WordPress 說明文件團隊一直在實施未公開但一致的發布指南方法。但偶爾還是會有部分元素遭到預先淘汰，然後進行推測。為了撰寫及發布 WordPress 報導，目前尚未建立任何固定標準和條件。技術文件團隊已撰寫專案專屬的格式指南，但沒有任何指南適用於所有情況。大多數現有的樣式指南並未整合在單一手冊中，或是已淘汰並需要更新。因此，我們需要設計及開發統一的樣式指南，以便將 WordPress 說明文件標準化。
目標：
超過 35% 的網站都是使用 WordPress 運作，這也表示有數百萬名開發人員和使用者在使用 WordPress 的強大功能。說明文件是協助開發人員和使用者順利執行這些功能的重要元素，即使遇到不便之處，也能輕鬆解決。本專案提案的整體目標是標準化設計與風格指南、統整現有風格指南與更新內容，以及附加 WordPress 說明文件的新法規和規格。這有助於 WordPress 說明文件中的使用、簡易性和一致性。
實作：
根據導師 (Jon Ang) 針對本專案提出的建議，您可以透過 4 個階段來處理專案：探索、定義、實作和維護階段。在專案開始前，我會與導師一起在實習工作開始之前，和導師一起擬定好合適的時間表和時間表，合力規劃相應的時程和交付項目。我會進一步熟悉 WordPress 系統和這項專案的工作通訊協定。
實習計畫開始後，我會與導師討論並起草計畫摘要。相關規定和必要條件會一一判斷。首先，我會簡單說明說明文件的流程和使用者互動程序。接著，我們會概略說明各個區段、類別和元件的版面配置線框。這些版面配置會由導師審查。視需要重新設計版面配置，並新增/移除某些元件。接著，我會進行使用者研究，判斷介面流程的可用性和可行性。接著，我們會依照下圖所示，逐節實施說明文件樣式指南。如果有其他機構採用任何開放原始碼或創用 CC 授權，請參照這些機構提供的風格指南，並附上指南。如果在這段期間發生任何可用性問題，我會重新設計。
完成風格指南並與 HelpHub 整合後，我們會進行測試和最佳化。任何安全漏洞、多餘的元素或元件都會修正。我們會進行 UI 和程式碼測試，並視需要修正不必要的錯誤和錯誤。我們會針對完整的風格指南進行最終品質控管，檢查語言、文法、拼字、標點符號等。
由於不可預期的延誤，導致工作處於待處理狀態，這些工作會在緩衝期內完成。在最終測試完成後，您可以實作在專案過程中判斷可行性的其他功能。建構部署計畫，並提交成品。
工具與方法：
我們會在「Google 文件」等協作平台上彙整及編輯說明文件。如果必須透過 GitHub 發布，也可以實作 Markdown 或 GitHub Flavored Markdown 等標記語言。如需設計和樣式標準，您也可以參考開放原始碼樣式指南。最後，系統會使用 WordPress 為完成的文件設定格式並發布。
元件表格：
以下清單完整列出可在樣式指南中實作的元件。文件規範 - 無障礙、文件結構、編碼、外部來源、事實、字型、全球觀眾、包容性、合法性、多平台無障礙、不含模糊字眼、不誇大不實、頁面版面配置、政治正確性、通訊協定、安全性、句子結構、簡潔的寫作、語氣與風格、不偏頗
語言與文法 - 縮寫與縮寫詞、肯定與否定、冠詞、大寫、子句、直接/間接引述、第一人稱/第二人稱/第三人稱、性別、詞彙、名詞、前置詞與後置詞、介系詞、代名詞、參照、俚語與行話、拼字、專業術語、時態、動詞、語態
標點符號 - 撇號和引號、冒號和分號、逗號、省略號、驚嘆號、連字號和破折號、括號、句號、問號、斜線
格式 - 摘要、前言、序言、品牌名稱、產品名稱、標題、程式碼片段、程式碼區塊、日期和時間、時區、地點、貨幣、檔案名稱、腳註、標題和標題、醒目顯示 (粗體、斜體、底線、刪除線、引號)、縮排、索引、連結和網址、清單、項目符號、編號、媒體 (圖片、影片) 和插圖、附註、警告、提示、數字和電話號碼、多語言、翻譯、語言文字、間距、表格、文字、商標、版權、專利、引文、教學課程和程序、使用者介面元素、度量單位
使用者介面 - 活動、按鈕、程式碼片段、程式碼區塊、命令列介面、對話方塊、選單和下拉式選單、彈出式視窗與快訊、分頁、術語、使用者介面元素、Windows
程式碼 - CSS、HTML、JS、Markdown、MySQL、PHP、語法、XML
字詞使用字典/詞彙解釋 - A 到 Z