TheGoodDocProject 專案
透過集合功能整理內容
你可以依據偏好儲存及分類內容。
本頁面包含 Google 技術文件季度接受的技術寫作專案詳細資料。
專案摘要
- 開放原始碼組織：
- TheGoodDocProject
- 技術撰稿人：
- Loquacity
- 專案名稱：
- 資訊架構指南
- 專案長度：
- 標準長度 (3 個月)
Project description
本文將說明如何規劃 Good Docs 專案資訊架構指南。這部影片是為了參加 2020 年 Google 文件季的活動而製作。這份文件將概述建議指南的用途，並草擬這類指南的結構規劃，以利規劃。
資訊架構 (IA) 是指內容的組織方式。涵蓋內容結構，但未定義內容本身的風格或字詞。舉例來說，資訊架構規劃會考量讀者是誰、他們如何接觸內容，以及他們閱讀內容的環境。接著，系統會考量內容的適當架構，以便最妥善地滿足讀者需求。
在理想情況下，您應先擬定內容策略，然後再設計文件，並利用業務目標來定義文件的目標。然後依據內容策略建立 IA，定義說明文件的版面配置和結構。接著，您可以選擇工具鍊，並編寫內容。大多數開源專案的內容策略都很簡單，例如「撰寫一些說明文件，讓使用者瞭解如何使用這個專案」，但即使是這麼簡單的策略，也足以定義有效的資訊架構。
本指南旨在提供簡易工具，讓非專業作者能夠開發資訊架構，並據此決定要使用哪些範本。這個過程應可讓一般人在下午午後完成，並傾向於鼓勵在教育之餘採取行動。理想情況下，它會以簡潔的方式介紹概念，引導讀者思考這些概念與其專案的關聯，並利用結果繼續學習下一個概念。
為了為這項專案建立結構，我們需要更新專案的 README，讓讀者瞭解如何開始使用 Good Docs 專案，並能有效運用資訊架構指南，選擇適合的範本。
主要收視對象
所有希望使用 The Good Docs Project 範本為專案建立文件的使用者
使用案例：
本節旨在探討讀者應如何遵循《IA 指南》。這有助於我們判斷指南的結構，以便為這些讀者提供最佳服務。
情境：某人正在處理的開源專案沒有或幾乎沒有相關文件，或是文件套件組織或撰寫方式不佳。他們決定使用 The Good Docs Project 整理說明文件，但不確定該從何處著手。他們會按照 README 瞭解如何開始使用範本，並按照 Information Architecture Guide 制定內容策略，並規劃說明文件套件的外觀。
提案
更新 README 檔案，更明確地引導新讀者完成專案，包括清楚的首要步驟。其中一個初步步驟，就是閱讀並回答新版 IA 指南中的相關問題。這份指南會邀請讀者考量目標對象、內容結構定義、使用者/工作矩陣等，而不必讓讀者花費太多心力學習/瞭解這些概念的學術意義。完成這項工作後，讀者就能瞭解需要哪些範本，以及如何最佳化範本。
研究
為了以研究結果做為佐證，我會大量參考 Abby Covert 的書籍 (http://www.howtomakesenseofanymess.com/)，一方面是因為我非常熟悉這本書，而且我已撰寫許多內容，並將運用這些內容，因此這本書已成為我撰寫內容的基礎；另一方面是因為，如果有興趣，新手很容易就能閱讀這本書。這有點像 IA 閘道藥品，
草擬目錄
讀我資訊：
-- 優質文件專案簡介
|_ 誰應使用這些範本
|_ 範本運作方式
|_ 為專案貢獻內容
-- 範本
|_ 目前所有範本清單
|_ 選擇要使用的範本
|_ 開始前
-- 開始撰寫前
|_ 誰會閱讀文件？
|_ 為什麼他們要閱讀說明文件？
|_ 為讀者撰寫內容
IA 指南：
-- 簡介
|_ 什麼是 IA？
|_ 為什麼要關注？
-- 找出問題所在
-- 說明您的意圖
-- 面對現實
-- 選擇方向
-- 評估距離
-- 運用結構
-- 準備調整
除非另有註明，否則本頁面中的內容是採用創用 CC 姓名標示 4.0 授權。詳情請參閱《Google Developers 網站政策》。Java 是 Oracle 和/或其關聯企業的註冊商標。
上次更新時間：2025-07-25 (世界標準時間)。
[null,null,["上次更新時間：2025-07-25 (世界標準時間)。"],[[["\u003cp\u003eThis project aims to create an Information Architecture (IA) Guide for The Good Docs Project to help users structure their documentation effectively.\u003c/p\u003e\n"],["\u003cp\u003eThe IA Guide will simplify content organization for non-professional writers using The Good Docs Project templates.\u003c/p\u003e\n"],["\u003cp\u003eThe project involves updating the project's README to provide clearer guidance and integrate the IA Guide into the workflow.\u003c/p\u003e\n"],["\u003cp\u003eBy following the IA Guide, users can define their content strategy, choose appropriate templates, and improve the overall structure of their documentation.\u003c/p\u003e\n"],["\u003cp\u003eThe IA Guide draws inspiration from Abby Covert's book, "How to Make Sense of Any Mess," and focuses on a practical, action-oriented approach.\u003c/p\u003e\n"]]],["The project aims to create an Information Architecture (IA) guide for The Good Docs Project, intended for non-professional writers. The guide will help users define their content structure by considering reader needs and project goals. Key actions include updating the project's README to guide new users, developing the IA guide that focuses on practical application over theoretical knowledge and leading the user through steps to consider audience, schema, and task matrix. The IA guide will be developed based on the user-focused concept from the book \"How to Make Sense of Any Mess\" by Abby Covert.\n"],null,["# TheGoodDocsProject project\n\nThis page contains the details of a technical writing project accepted for\nGoogle Season of Docs.\n\n### Project summary\n\nOpen source organization:\n: TheGoodDocsProject\n\nTechnical writer:\n: Loquacity\n\nProject name:\n: Information architecture guide\n\nProject length:\n: Standard length (3 months)\n\n### Project description\n\n#### *Information Architecture Guide Plan*\n\nThis document covers planning for an information architecture guide for the Good Docs Project. It was prepared as part of a Google Season of Docs 2020 submission. It outlines the use case for the proposed guide, and sketches out a plan of the structure of such a guide, for planning purposes.\n\nInformation architecture (IA) concerns how content is organised. It covers the structure of content without defining the style or words used within the content itself. For example, an IA plan would consider who the reader is, how they approach the content, and the environment within which they are reading. It would then consider an appropriate structure for the content that would best serve these reader requirements.\n\nIn a perfect world, documentation is designed by starting with a content strategy, which uses business goals to define the goals of the documentation. The content strategy is then used to create an IA, which defines the layout and structure of the documentation. From there, toolchains can be chosen, and content written. The reality of most open source projects is that the content strategy is as simple as \"write some documentation so people know how to use this project\", but even that simple strategy is enough to be able to define an effective IA.\n\nThe intent of this guide is to provide a simplified tool for non-professional writers to develop an IA that is sufficient for determining which templates they should use. It should be simple enough to be completed by an ordinary human in an afternoon, and should favour action over education. Ideally, it will introduce concepts in a succinct way, guide the reader to consider those concepts in relation to their own project, and use the result of that to move on to the next concept.\n\nAs scaffolding for this project, some updates to the project README are required, so that readers understand how to get started with the Good Docs Project, and are able to use the IA guide effectively to guide their template choices.\n\n#### *Primary audience*\n\nAll people looking to use The Good Docs Project templates to create documentation for their project\n\nUse cases:\nThis section is designed to explore how readers approach the IA Guide. This can help us to identify how the guide should be structured in order to best serve those readers.\n\nScenario:\nA person is working on an open source project that has little or no documentation, or a documentation suite that is badly organised or written. They decide to use The Good Docs Project to organise their documentation, but are not sure where to begin. They follow the README to understand how to get started with the templates, and follow the `Information Architecture Guide` to develop their content strategy and plan out how their documentation suite will look.\n\n#### *Proposal*\n\nUpdate the README to more clearly guide the new reader through the project, including clear first steps. One of those first steps would be to read and answer the questions in a new IA Guide. That guide would invite the reader to consider audience, content schema, user/task matrices, etc, without putting too much burden on the reader to learn/understand what those things are in an academic sense. Once this task is completed, the reader has an understanding of what templates are required, and how to best complete them.\n\n#### *Research*\n\nIn order to back this up with research, I would lean pretty heavily on Abby Covert's book (http://www.howtomakesenseofanymess.com/), partly because I'm very familiar with it and it has formed the basis of a lot of content I have already written and will be making use of, but also because it's very easy for people new to IA to pick up and read if they have further interest. It's a bit of an IA gateway drug, in that sense.\n\n#### *Draft ToC*\n\nREADME:\n\n-- Introduction to The Good Docs Project\n\\|_ Who should use the templates\n\\|_ How the templates work\n\\|_ Contributing to the project\n-- The templates\n\\|_ List of all current templates\n\\|_ Choosing which templates to use\n\\|_ Before you begin\n-- Before you start writing\n\\|_ Who reads the docs?\n\\|_ Why do they read the docs?\n\\|_ Writing for your readers\n\nIA Guide:\n\n-- Introduction\n\\|_ What is IA?\n\\|_ Why should I care?\n-- Identify the mess\n-- State your intent\n-- Face reality\n-- Choose a direction\n-- Measure the distance\n-- Play with structure\n-- Prepare to adjust"]]
