为了保持手册之间的一致性，请遵循本风格指南。本指南的目的是帮助您创建对所有读者都可读且有用的文档。高级用户应该能够扫描文档并选择他们需要的内容。但您仍然需要包含详细信息以帮助新手用户。
写入非正式但知识渊博的方式。读者应该觉得这是一个朋友向他们清楚地解释了一些事情。
解释你需要做什么尽量少说话.
始终在第二人称也就是说，你，而不是我们，像他们坐在你旁边一样对读者讲话。
对的
登录到WordPress管理屏幕。
不正确
接下来，我们需要登录WordPress。
坚持每篇文章一个主题。不要分散到其他主题，但在相关的地方链接到它们。
例子
本文将向您展示如何通过github GitHub是一个提供git存储库在线实现的网站，其他开发人员可以轻松共享、复制和修改这些存储库。公共存储库可以免费托管，私有存储库需要付费订阅。GitHub引入了“拉请求”的概念，在将贡献者在分支中所做的代码更改合并为存储库所有者之前，可以对其进行审查和讨论。https://github.com/。在开始之前，您需要有一个本地服务器。你可以在本文介绍如何在本地安装WordPress.
写文章时，每段坚持一个要点这将有助于保持文件的清晰性。一个好主意是事先计划好你要写什么，写下你想写的每一点。
- 使用大胆的使重要的观点突出或指示指示：例如。导航到页面>添加新内容
- 如果您想提醒用户一些事情，请使用以下短代码：
[信息]
[提示]
[提醒]
[警告]
[教程]
教程应使用此短代码 短代码是在WordPress帖子、页面或小部件中使用的占位符，用于在网站的特定位置插入插件生成的表单或函数。，但必须从前面的教程继续。
- 使用有序和无序列表
- 使用标题标记以正确的顺序从h2到h6
- 当提及时菜单项，使用“页面>添加新内容”格式
- 使用阻碍.
WordPress v5.0将引入块编辑器（代号Gutenberg）。内容被分解为单独的块（图像、列表、段落、标题等）。如果您正在迁移或编辑使用Classic Block的文章，请随意将其转换为实际的单独块。
如何处理文件名：
[保留的文本5ce7c31ec4642f252291d006cfc6097c/]
要插入代码示例，请用正确的短代码包装代码。例如：
[php（电话）][/php（电话）][html格式][/html格式]
函数、钩子、方法、类和变量都应该包装在<code>HTML标记中，并正确链接到代码引用。链接应该开始里面代码标签。
当一个页面完成时，应该没有到Codex的链接，除非developer.wordpress.org上没有该文档。
图像应为全尺寸。除非绝对必要，否则不要包含读者必须单击才能看到的缩略图。要拍摄看起来很棒的屏幕截图，请调整浏览器窗口的大小。通过向下调整大小，您可以对所指屏幕的特定区域进行屏幕截图。
避免大块文本。让你的文章段落短小精悍。在相关的地方使用标题，便于人们浏览。
教程应该始终以清晰、合乎逻辑的方式书写。您应该执行以下操作：
- 有一个引言段这告诉读者他们将做什么。
- 包括他们将要做的任何事情的列表需要.
- 每个步骤都应该有一个明确的任务.
- 每个步骤都应该有一个简洁地说明任务是什么的标题.
- 每个步骤标题应为编号并包裹在适当标题标签。
- 如果相关，包括截屏.
下面的示例演示了使用FTP下载BuddyPress并上传到WordPress的简单教程。
1.下载BuddyPress并解压缩
导航到WordPress插件库并下载BuddyPress。解压缩到计算机上很容易找到的文件夹。
2.通过SFTP上传到wp-content/plugins/
打开您最喜欢的SFTP程序（例如FileZilla）。输入SFTP登录详细信息。如果你没有这些，你可以从你的网络主机上获得它们。
登录到服务器后，导航到wp-content/plugins/。在本地服务器上，找到解压缩的BuddyPress文件夹。将文件夹拖放到远程网站。
3.激活插件
登录WordPress。导航到插件。找到BuddyPress插件并单击激活链接.
请记住，并不是每个人都能看到您的屏幕截图或其他解释性图像。所以请不要过分依赖它们。
无法自动播放动作，用户应该可以控制动画、视频、声音等
建议采取以下解决方案：
- 使用视频而不是gif。用户可以通过播放和停止来控制视频，包括在视频中来回移动。
- 如果无法播放视频且必须是gif（例如，因为内容需要重新制作），请在单击播放按钮时提供缩略图，而不是带有播放图标的gif，并让gif播放（也可以停止播放）。因此，既可以阅读gif，也可以从容地阅读帖子，不分心。
创建链接文本时，请注意，在某些用户代理中，链接可能会在上下文之外呈现（例如JAWS屏幕阅读器). 因此，避免使用“here”或“this”这样的通用文本，并确保链接文本描述您所指向的资源。在包含多个链接的页面上，确保每个链接文本都是唯一的，除非您在多个位置链接到同一资源。
尽可能避免使用行话、缩写和首字母缩写。如果您确实需要使用缩写，请首先使用完整的扩展版本，然后使用括号（括号）中的缩写。或者，使用正确的缩写标记，例如：
W3C
上次更新时间：