本页面包含有关 Google 文档季可接受的技术写作项目的详细信息。
项目摘要
- 开源组织：
- WordPress
- 技术文档工程师：
- tacitonic
- 项目名称：
- 完整的文档风格指南（更新版）
- 项目时长：
- 长期投放（5 个月）
Project description
剧情简介：
WordPress 是一家全球非营利软件组织，致力于通过注重无障碍功能、性能、安全性和易用性的软件为全球社区提供服务。WordPress 的公益事业致力于在网络上普及发布软件和开源软件。在数字化时代，网站实际上就是组织/个人的在线形象；而 WordPress 的任务是高效服务数以亿计的用户（其运行的 35% 互联网用户）使用他们的软件。事实证明，为了进一步高效地服务于这些用户，文档至关重要，大多数开发者、管理员和最终用户都会使用文档。因此，文档可以确定为 WordPress 生态系统的主要因素。当前的 WordPress 文档未包含一套通用且统一的发布规则和样式指南。此方案旨在制定一套完整且更新的文档样式准则，这些准则普遍适用于 WordPress 文档。项目创意涉及整合设计和样式指南的各个方面，例如语义、语法、语法指南、标点、开发专用规则、设计属性和格式细节。它还纳入了语气、语气、时态、所有词性以及命名惯例等语言规范。所使用的工具、语言和平台将包括 WordPress CMS、GitHub、Markdown，还可能包括 PHP/MySQL、HTML/CSS 和 JavaScript。
项目计划：
WordPress 文档风格指南的现状： WordPress 文档团队一直在实施一种未声明但一致的发布准则方法。但有些时候，某些元素就被预先设定为假设，这个过程变成了推测。对于为 WordPress 撰写和发布文章，还没有任何固定的标准和标准。文档团队已经编写了特定于项目的样式准则，但这些准则并不存在。现有的大多数样式指南并未整合到一本手册中，或者已废弃并需要更新。因此，您需要设计和制定统一的样式指南，以对 WordPress 文档进行标准化。
目标：
互联网上有超过 35% 的网站在 WordPress 上运行，这表明有数百万开发者和最终用户正在使用 WordPress 的强大功能。要协助开发者和用户高效实现这些功能，文档是至关重要的一环，即使出现不便也是如此。此项目提案的总体目标是对设计和风格指南实现标准化、统一现有风格指南并进行更新，并为 WordPress 文档附加新的法规和规范。这样可确保 WordPress 文档中的易用性、简洁性和统一性。
实现：
按照此项目的导师 (Jon Ang) 的建议，该项目可以分为 4 个阶段：发现阶段、定义阶段、实施阶段和维护阶段。在项目开始之前，在实习前期，我将与导师一起根据接下来的时间安排和可交付成果确定合适的时间表和时间表。我将进一步熟悉 WordPress 系统和此项目的工作协议。
实习开始后，我将与导师讨论并起草该计划的摘要。我们会确定具体要求和必要性。首先，我会简要介绍文档流程和用户互动流程。接下来，简要介绍每个部分、类别和组件的布局线框。然后，我的导师会审核这些布局。如有需要，我们将重新设计布局并移除一些组件。然后，我会进行用户调查，以确定界面流程的易用性和可行性。随后，将按章节实施文档风格指南（如下图所示）。对于采用任何开放源代码或知识共享许可的其他组织的风格指南，您也可以参考这些指南，在末尾附上该指南。如果在此期间出现任何易用性问题，我会重新设计它们。
风格指南完成并与 HelpHub 集成后，您将进行测试和优化。所有漏洞、冗余元素或组件都将得到修复。我们将进行界面和代码测试，并根据需要修复不必要的 bug 和错误。并将对语言、语法、拼写、标点等进行完整风格指南的最终质量控制。
由于意外延误而待处理的任务会在缓冲期内完成。在项目执行过程中确定可行的其他功能，可在最终测试完成后实施。系统会构建部署计划并提交成品。
工具和方法：
文档将在 Google 文档等协作平台上进行编译和编辑。如果需要通过 GitHub 发布，您也可以实现 Markdown 或 GitHub Flavored Markdown 等标记语言。对于设计和样式标准，还可以参考开源样式准则。最后，利用 WordPress 将完成的文档格式化并发布。
组件表：
下面列出了可在风格指南中实现的组件的详尽列表。 文档指南 - 无障碍功能、文档结构、编码、外部来源、事实、字体、全球受众、包容性、合法性、多平台可访问性、非歧义、没有过多声明、页面布局、政治正确性、协议、安全性、句子结构、简洁的写作、语气和风格、公正客观
语言和语法 - 缩写和首字母缩略词、自我肯定话语、文章、大写、从句、直接/间接讲话、第一/第二/第三人称、性别、词汇表、名词、前缀和后缀、介词、代词、引用、俚语、专业术语、专业术语、
标点 - 撇号和引号、冒号和半角冒号、逗号、省略号、感叹号、连字符和短划线、圆括号、句号、问号、斜线
格式 - 摘要、简介、前言、品牌名称、产品名称、文字说明、代码段、代码块、日期和时间、时区、地点、货币、文件名、脚注、标题和标题、突出显示（粗体、斜体、下划线、删除线、删除线、视频标注、链接、编号、标点、标点、标注、标点、标点、标注、标点、标注、标点、标点、标注、标点、标注、标点和标点等）
界面 - activity、按钮、代码段、代码块、命令行界面、对话框、菜单和下拉菜单、弹出式窗口和提醒、标签页、术语、界面元素、Windows
代码 - CSS、HTML、JS、Markdown、MySQL、PHP、语法、XML
字词用法字典/术语表 - 从 A 到 Z