本页面包含有关 Google 文档季可接受的技术写作项目的详细信息。
项目摘要
- 开源组织：
- 知识共享
- 技术文档工程师：
- JackieBinya
- 项目名称：
- WordPress 基础主题使用指南
- 项目时长：
- 标准时长（3 个月）
Project description
在申请 GSOD-2020 的技术文档工程师阶段，我与 Hugo Solar 有过多次互动。Hugo Solar 是知识共享 WordPress 基础主题文档项目的导师。
在与他首次联系时，我向他寻求帮助，希望了解制定 WordPress 基础主题使用指南的目标，他非常乐于助人，很快就让我参与了这个项目。此后，我们进行了多次关于优化 CC WordPress Base 主题文档目标的互动。
在达到一定阶段后，我觉得自己已了解项目的要求和目标，然后为《CC WordPress Base 主题使用指南》拟定了一份提案草稿。
此提案是使用面向实习生的知识共享官方模板创建的。其中提供了项目简介、项目结构提议和新 WordPress 基本主题文档的布局信息，以及文档创建阶段的时间表和交付成果的相关信息。
然后，Hugo Solar 查看了我的提案草稿，并提供了反馈以便我进行改进。在整个过程中，他随时都能回答有关该项目的问题。
我已采纳用户反馈，我关于制作 D&I 徽章文档的最终提案可通过以下链接找到（以 Google 文档的形式）
https://docs.google.com/document/d/1XmIsMTLstbhRRSaNFP538YOXJiS0G5QrN6EzuqJfRy4/edit?usp=sharing
下面还简要概述了我的方案，内容如下：
知识共享 - WordPress 基础主题使用指南 Jacqueline Binya 撰写的提案，2020 年 6 月 28 日
项目摘要 此项目的最终目标是为知识共享 WordPress 基础主题创建内容丰富、直观、有吸引力且呈现精美的面向社区的文档。
项目计划 问题 目前，知识共享 WordPress 基础主题尚无文档，这是在社区中有效利用该主题的障碍。 我的目标是创建主题的完整使用指南，并在 WP Base 主题的当前代码库中实现抽象，以便更轻松地使用主题。
解决方案：使用 Gatsby 等现代框架创建未来主义文档。Gatsby 提供了一些起始资源，可用于引导新的 WordPress 基本主题文档。例如 gatsby-gitbook-starter，它开箱即可使用，支持搜索引擎优化 (SEO)、markdown 和 Algolia（用于集成静态网站中搜索功能的工具）。除此之外，Gatsby 生成的所有网站都可以轻松进行优化，从而集成国际化和可访问性。 在创建文档时，我的意图是尽可能地让它直观明了： - 以易于理解的方式编写文档，注意避免含糊不清和使用过多的复杂技术术语。 -- 使用演示如何执行常见任务（如自定义）的示例。
我希望实现的抽象包括确保用户能够通过 WordPress 管理控制台利用 WP 基本主题的大部分核心功能（例如钩子）。除此之外，我还想在单独的代码库中为 WP 基本主题创建初始子主题。采用初始的儿童主题可为新用户提供更顺畅、更快速的新手入门体验。 文档完成并获得批准后，就会在线发布并托管。
CC WordPress 基础主题使用指南的提议结构 - 提议的文档分为以下几部分。然后，各建议部分下的子列表项会详细说明可在相应部分中找到的实际内容。
“概览”部分 - 概述知识共享(CC) WordPress 基本主题的定义、意图和功能。 * 定义：简要描述 CC WP 基本主题。 * 意图：概述 CC WP 基本主题的目标/ 意图 * 功能：概述 CC WP 基本主题的功能
“使用入门”部分 - 要求 * 概述安装 CC WordPress 基本主题的要求，即 - WordPress 版本 - PHP 版本 - Composer 等 - 安装指南 * 概述用户如何使用 zip 安装 CC WordPress 主题 * 概述用户如何开始使用从 GitHub 克隆 WP 基础主题。 * 概述用户如何在项目中安装依赖项。 * 说明用户如何配置依赖项 Queulat。 * 说明用户如何在其本地 WordPress 开发环境中激活主题。
使用指南 - 概览 * 解释“子主题”这一术语 * 说明使用子主题的优势。 * 告知用户，建议通过子主题修改 WP Base 主题。 * 强调必须先安装并激活 WP 基本主题，用户才能创建子主题。
使用子主题 - 说明用户如何使用启动方式创建 WP 基本主题的子主题。 使用视频说明用户如何从启动方式创建子主题。
自定义 在下面的小节中，我们概述了用户如何使用 WordPress 定制工具和 WordPress 管理控制台进行自定义。我们还将采用图形图示，以使说明更加直观。 - 自定义网站说明或宣传口号。 - 自定义导航菜单 - 自定义 CSS - 添加页面 - 添加帖子 - 微件 - 在 WordPress 管理控制台中添加和移除微件 - 使用具有实时预览的定制工具添加微件
“高级自定义”部分 - 自定义 CSS 部分 * 描述构成主题样式的组件： - 字幕词汇 - Bulma - Sass * 说明如何在项目中设置 Sass。说明应包含以下信息： (i) sass 文件在项目结构中的位置 (ii) 可用于构建和监控 sass 的 npm 脚本 * 说明用户如何随后在子主题中自定义 sass 样式，即通过安装特定的 npm 依赖项 * 说明如何使用组件类 (class-component.php) 来自定义特定组件的样式
- 钩子部分
概览
- 解释钩子这个术语
- 说明用户为何需要使用钩子。
- 简要介绍可用的钩子类型。
使用操作
- 列出 WP Base 主题中提供的操作及其位置
- 说明如何实现这些操作。
*使用过滤器 - 列出主题中可用的过滤器，并说明如何实现这些过滤器
更新主题部分 - 说明用户如何更新主题。
许可部分 * 介绍项目许可，以及这对可能希望在个人项目中使用 CC WP 基本主题的用户来说意味着什么。
“贡献”部分 * 添加详实的贡献指南 * 概述行为准则 * 社区：提供有关知识共享社区频道的信息，以及贡献者如何参与的信息等。