TheGoodDocsProject 项目

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

项目摘要

开源组织:
GoodDocsProject
技术文档工程师:
Loquacity
项目名称:
信息架构指南
项目时长:
标准时长(3 个月)

Project description

信息架构指南方案

本文档介绍了如何规划 Good 文档项目的信息架构指南。本文档是 2020 年 Google 文档季提交内容的一部分。其中概述了建议的指南的使用场景,并草拟了此类指南的结构计划,以便于规划。

信息架构 (IA) 关注内容的组织方式。它涵盖了内容的结构,但没有定义内容本身使用的样式或字词。例如,信息架构规划会考虑读者是谁、他们如何看待内容,以及他们是在什么样的环境中阅读。然后,它会考虑合适的内容结构,以便更好地满足这些读者的要求。

在理想情况下,文档设计从内容策略开始,也就是使用业务目标来定义文档的目标。然后,我们会利用内容策略来创建定义文档的布局和结构的信息架构。之后,可以选择工具链并编写内容。大多数开源项目的现实情况是,内容策略就像“编写一些文档,告诉人们如何使用以下项目”,但就算是这种简单的策略也足以定义有效的信息架构。

本指南旨在为非专业作家提供简化的工具,让他们能够开发出充分考虑应使用哪些模板的信息架构。它应该简单到只需一个普通人一个下午就能完成,并且更注重行动,而非教育。理想情况下,它会以简明扼要的方式介绍概念,引导读者围绕自己的项目考虑这些概念,并根据结果继续下一个概念。

作为此项目的基石,我们需要对项目自述文件进行一些更新,以便让读者了解如何开始实施 Good Docs 项目,并能够有效地利用信息架构指南引导他们选择模板。

主要受众群体

所有希望使用 Good 文档项目模板来为项目创建文档的用户

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

场景:某人正在处理一个文档很少甚至没有文档的开源项目,或者一个文档套件没有条理或文笔欠佳。他们决定使用 Good 文档项目来整理他们的文档,但不知道从何处入手。他们按照自述文件了解如何开始使用模板,并按照Information Architecture Guide来制定内容策略并规划其文档套件的外观。

提案

请更新自述文件,以更明确的方式引导新读者完成整个项目,包括明确的前几个步骤。首要步骤之一是在新的信息架构指南中阅读并回答问题。该指南会邀请读者考虑受众群体、内容架构、用户/任务矩阵等,同时又不会给读者在学术意义上学习/理解这些内容的负担过多。完成此任务后,读者了解需要哪些模板,以及如何最好地完成这些模板。

研究

我主要依赖 Abby Covert 的书 (http://www.howtomakesenseofanymess.com/)从这个意义上讲,这有点像是信息安全部门的门户药物。

服务条款草稿

自述文件:

-- 优秀文档项目简介 |_ 模板的使用者 |_ 模板的工作原理 |_ 参与项目 -- 模板 |_ 当前所有模板的列表 |_ 选择要使用的模板 |_ 开始前须知 -- 开始撰写之前 |_ 谁负责阅读文档? |_ 他们为什么要阅读文档? |_ 为读者撰写文案

信息架构指南:

-- 简介 |_ 什么是信息架构? |_ 我为何应关注? -- 找出混乱之处 -- 说出您的意图 -- 面对现实 -- 选择方向 -- 测量距离 -- 玩转结构 -- 准备进行调整