本頁針對 Google 系列文件接受的技術撰寫專案提供詳細資料。
專案摘要
- 開放原始碼機構：
- TheGoodDocsProject
- 技術文件撰寫者：
- Loquacity
- 專案名稱：
- 資訊架構指南
- 專案長度：
- 標準長度 (3 個月)
Project description
資訊架構指南
本文件涵蓋完善文件專案資訊架構的規劃指南。本計畫已彙整為 2020 年 Google 文件季度提交內容中。其中概述建議的指南的應用實例，並草擬這份指南的架構計畫，以便用於規劃。
資訊架構 (IA) 關注內容的編排方式，涵蓋內容結構，而不會定義內容本身的風格或字詞。舉例來說，IA 的計劃會考量讀者的身分、內容的處理方式，以及閱讀環境。並選出最適合滿足這些讀者需求的內容架構。
最值得注意的是，說明文件是從內容策略開始著手，該策略會根據業務目標定義說明文件目標。然後透過內容策略建立 IA，定義說明文件的版面配置和結構。您可以從中選擇工具鍊和編寫內容。多數開放原始碼專案的實際情況在於，內容策略就像「撰寫一些說明文件，讓人知道如何使用這項專案」一樣簡單，不過只要簡單的策略就足以定義有效的 IA。
本指南旨在提供方便非專業作家的簡化工具，協助非專業作家打造順利的 IA，充分判斷應使用哪些範本。這項做法應讓一般人在下午能輕鬆完成，且應該鼓勵大眾採取行動，教育大眾。在理想情況下，本練習會簡單介紹概念，引導讀者思考與自己的專案相關的概念，然後運用結果發展下一個概念。
由於這項專案的鷹架，因此需要對 README 專案進行更新，以便讀者瞭解如何開始使用「Good Docs Project」，以及運用 IA 指南有效引導範本選擇。
主要目標對象
所有想使用「優質文件專案」範本製作專案文件的使用者
用途： 本節旨在說明讀者如何採行 IA 指南。這有助於我們判斷指南的結構，以便為這些讀者提供最優質的服務。
情境：一個人在處理的開放原始碼專案幾乎沒有或完全沒有相關文件，或是文件套件的編排或編寫不良。他們決定使用 The Good Docs Project 整理文件，但不確定該從何處著手。他們會根據 README 檔案著手使用範本，並跟著Information Architecture Guide制定內容策略，並規劃說明文件套件的外觀。
提案
請更新 README，更清楚地引導新讀者完成專案，並提供清楚的最初步驟。第一步就是閱讀並回答《新的 IA 頻道指南》中的問題。該指南可以邀請讀者考慮目標對象、內容架構、使用者/工作矩陣等，但讀者不會為學習/瞭解學術界所投入的心力過多。這項工作完成後，讀者就能瞭解所需範本，以及如何妥善完成範本。
研究
為了支持這項研究，我必須深入瞭解 Abby Covert 的著作 (http://www.howtomakesenseofanymess.com/)，部分是因為我非常熟悉，且能夠根據我已撰寫的許多內容建立基礎，但也是因為感興趣的使用者很容易在 IA 中學習和閱讀。聽起來是 IA 閘道類藥物。
草稿服務條款
讀我資訊：
-- 優質文件專案簡介 |_ 誰適合使用範本 |_ 範本的運作方式 |_ 適用於專案 -- 範本 |_ 所有現有範本的清單 |_ 選擇要使用的範本 |_ 開始撰寫之前 |_ 誰能閱讀文件？ |_ 他們為什麼會閱讀說明文件？ |_ 撰寫文章給讀者
IA 指南：
-- 簡介 |_ 什麼是 IA？ |_ 為什麼要這麼做？ -- 辨別訊息 -- 說明意圖 -- 臉孔 - 選擇方向 -- 測量距離 -- 嘗試結構 -- 準備調整