本页面包含 Google 文档季接受的技术写作项目的详细信息。
项目摘要
- 开源组织：
- WordPress
- 技术文档工程师：
- tacitonic
- 项目名称：
- 一套完整且经过更新的文档样式指南
- 项目时长：
- 长时间运行（5 个月）
Project description
剧情简介：
WordPress 是一个全球性公益软件组织，致力于为全球社区提供注重无障碍性、性能、安全性和易用性的软件。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、按钮、代码段、代码块、命令行界面、对话框、菜单和下拉菜单、弹出式窗口和提醒、标签页、术语、界面元素、窗口
代码 - CSS、HTML、JS、Markdown、MySQL、PHP、语法、XML
字词用法词典/术语表 - A 到 Z