本頁針對 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 說明文件標準化。
目的：
WordPress 有 35% 的網際網路網站都採用 WordPress 技術，這表示數百萬名開發人員和使用者皆採用 WordPress 出色的功能。說明文件是不可或缺的一環，可協助這些開發人員和使用者有效率地完成各項功能，即使造成不便也不受影響。本專案提案的整體目標，是將設計與樣式指南標準化、統合現有的樣式指南並進行更新，以及為 WordPress 說明文件附加新法規和規範。這樣就能讓 WordPress 說明文件易於使用、簡單又統一。
執行：
根據這項專案的導師 (Jon Ang) 建議，本專案分為 4 個階段：探索、定義、導入和維護階段。開始進行專案之前，在實習前，我會與導師合作，確認符合規定的時間表和時程，依循後續時程及交付項目。我會進一步熟悉 WordPress 系統和本專案的工作通訊協定。
隨著實習計畫開始，我會和導師討論並草擬計畫的概要。我們會判斷相關規定和必要性。首先，我會概略說明說明文件的流程和使用者互動程序。接下來，將列出每個區段、類別和元件的版面配置線框。我的導師會審查這些版面配置。如有需要，系統會重新設計版面配置，並新增/移除部分元件。接著，我會進行使用者研究，確認介面流程的可用性和可行性。接著，每個章節實施「說明文件樣式指南」(如下圖所示)。如果其他機構屬於開放原始碼或創用 CC 授權，也可以參考我們的指南。如果在這段期間內有任何可用性問題，我會重新設計。
完成風格指南並與 HelpHub 整合後，系統就會執行測試及最佳化。任何安全漏洞、多餘的元素或元件都會經過修正。我們會執行使用者介面和程式碼測試，並修正不需要的錯誤和錯誤。我們將針對語言、文法、拼字和標點符號等所有樣式指南進行最終品質控管。
因意外延遲而待處理的工作會在緩衝期內完成。完成最終測試後，還能根據專案過程中實現的其他可用功能。系統會建立部署計畫，並提交完成的產品。
工具與方法：
我們將透過 Google 文件等協作平台編譯和編輯說明文件。如需透過 GitHub 發布，也可以導入 Markdown 或 GitHub Flavored Markdown 等標記語言。針對設計和樣式標準，您也可以參考開放原始碼樣式規範。最後，使用 WordPress 將完成的文件格式化並發布。
元件表格：
以下列出可以在樣式指南中實作的元件完整清單。文件指南 - 無障礙設計、文件結構、編碼、外部來源、事實、字型、全域目標對象、多元包容、合法性、多平台無障礙設計、不模糊、無過多聲明、頁面版面配置、政治正確性、通訊協定、安全性、語句結構、簡潔明瞭
語言與文法 - 縮寫和縮寫、確認與否定、文章、大寫字母、子句、直接/間接演說、第一人/第二人/第三人、性別、詞彙、名詞、字尾和字尾、前置詞、代名詞、推薦詞、口音、詞語和術語
標點符號 - 撇號和引號、方言、半透明、逗號、橢圓、驚嘆號、連字號、括號、句號、問號、斜線
格式 - 摘要、簡介、前言、品牌名稱、產品名稱、說明文字、程式碼片段、程式碼區塊、日期和時間、時區、地點、貨幣、檔案名稱、註腳、標題與標題、醒目顯示 (粗體、斜體、底線, 音符, 編碼, 字元索引, 文字索引, 英文符號, 英文符號
使用者介面 - 活動、按鈕、程式碼片段、程式碼區塊、指令列介面、對話方塊、選單與下拉式選單、彈出式視窗與快訊、分頁、術語、使用者介面元素、Windows
程式碼 - CSS、HTML、JS、Markdown、MySQL、PHP、語法、XML
詞彙使用字典/詞彙表 - A 到 Z