TheGoodDocsProject 项目

本页面包含 Google 文档季接受的技术写作项目的详细信息。

项目摘要

开源组织：
TheGoodDocsProject
技术文档工程师：
Loquacity
项目名称：
信息架构指南
项目时长：
标准时长（3 个月）

Project description

信息架构指南计划

本文档介绍了为“优质文档”项目规划信息架构指南。本文档是在 Google 2020 年文档季提交内容的过程中准备的。它概述了拟议指南的用例，并草拟了此类指南的结构计划，以便进行规划。

信息架构 (IA) 涉及内容的组织方式。它涵盖内容的结构，但不定义内容本身所使用的样式或字词。例如，信息架构计划会考虑读者是谁、读者如何理解内容以及读者是在什么样的环境下阅读内容的。然后，它会考虑最能满足这些读者需求的合适内容结构。

在理想情况下，文档设计应从内容策略着手，该策略会利用业务目标来定义文档的目标。然后，使用内容策略创建信息架构，定义文档的布局和结构。然后，您可以选择工具链并编写内容。事实上，大多数开源项目的内容策略都非常简单，例如“编写一些文档，让用户知道如何使用此项目”，但即使是如此简单的策略，也足以定义有效的 IA。

本指南的目的是为非专业作者提供一个简化的工具，帮助他们构建信息架构，以便确定他们应使用哪些模板。此类游戏应简单到可由普通人在下午完成，并且应注重行动而非教育。理想情况下，它应以简洁的方式介绍概念，引导读者将这些概念与自己的项目相关联，并利用这些结果来学习下一个概念。

作为此项目的脚手架，我们需要对项目自述文件进行一些更新，以便读者了解如何开始使用“优质文档”项目，并能够有效使用 IA 指南来指导其模板选择。

主要受众群体

希望使用 The Good Docs Project 模板为其项目创建文档的所有人

用例：本部分旨在探讨读者如何使用 IA 指南。这有助于我们确定应如何构建指南，以便为这些读者提供最佳服务。

场景： 某人正在工作的开源项目几乎没有文档，或者文档套件组织或书面。他们决定使用“优质文档”项目来整理文档，但不知道该从哪里开始。他们会按照自述文件了解如何开始使用模板，并按照 Information Architecture Guide 制定内容策略并规划文档套件的外观。

Proposal

更新自述文件，以便更清晰地引导新读者浏览项目，包括明确的第一步。其中第一步是阅读并回答新版 IA 指南中的问题。该指南会引导读者考虑受众群体、内容架构、用户/任务矩阵等，而不会给读者带来太多学习/理解这些概念的负担。完成此任务后，读者将了解需要使用哪些模板以及如何最好地完成这些模板。

研究

为了用研究来佐证这一点，我会大量参考 Abby Covert 的《How to Make Sense of Any Mess》（http://www.howtomakesenseofanymess.com/），这不仅是因为我非常熟悉这本书，它是我已经撰写和将要使用的大量内容的基础，还因为如果对 IA 有进一步兴趣，刚接触 IA 的人也能轻松上手阅读这本书。从这个意义上说，它有点像 IA 的诱导药物。

草稿服务条款

自述文件：

--《优质文档》项目简介 |_ 谁应使用这些模板 |_ 模板的运作方式 |_ 为项目做出贡献 -- 模板 |_ 当前所有模板的列表 |_ 选择要使用的模板 |_ 准备工作 -- 开始撰写前 |_ 谁会阅读文档？ |_ 他们为什么阅读这些文档？ |_ 为读者撰写

IA 指南：

-- 简介 |_ 什么是 IA？ |_ 为何我应该关注此功能？ -- 找出问题点 -- 表明意图 -- 直面现实 -- 选择方向 -- 衡量距离 -- 玩转结构 -- 做好调整准备