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