如果您是 WordPress 插件开发新手，您一定听说过 readme.txt 这个词。 这是一个用 markdown 语法格式编写的文本文件。 本文档包含介绍性信息以及插件的其他技术规范。
WordPress 存储库中有超过 60k 插件可用。 但是，只有少数人拥有编写良好的 readme.txt 文件。 缺少对 SEO 友好的自述文本会影响您插件的在线状态。
同时，它剥夺了用户获取信息的权利。 因此，您应该编写一个完整的自述文件，其中包含关键字、描述、功能、版本号、更改日志等。
编写自述文件更容易，但您还需要牢记一些技术事项。 在本文中，我们将向您展示如何为您的下一个插件创建一个 readme.txt 文件。
Readme.txt 实际上是什么
自述文件通过详细描述通知用户项目/软件，其中包括基本信息、操作指南、常见问题解答、升级通知等。
所有 WordPress 插件都应该有一个主 PHP 文件和一个 readme.txt 文件。 readme.txt 通常是使用明确定义的 markdown 子集编写的。 您以正确的格式添加所需的信息，WordPress 存储库会使用 markdown 语言对其进行解析。
它从 readme.txt 文件中提取信息并将其粘贴到公共存储库中。 然后，信息出现在特定插件页面的不同部分，所有用户都可以看到它们。
WordPress 插件审查团队代表 Mika Epstein 正确地说：
从本质上讲，Readme.txt 文件非常基础。 您输入信息，它会生成一个 WordPress 页面。 当然，这不仅仅是简单的魔法，还有一些奇怪的事情需要注意。
你不能只写你认为适合你的插件的纯文本。 WordPress 遵循全球惯例以保持一切和谐。 写得不好的自述文件很难接触到你的目标受众。 因此，我们在本博客的后面部分讨论了如何为 WordPress 创建 Readme.txt 文件。 继续阅读以了解更多信息。
为什么 Readme.txt 文件对您的插件很重要
不合格的 readme.txt 并不意味着您的产品不合格。 但是，这肯定表明您对细节的关注较少。 相反，一个很棒的自述文件最初可能会给你的观众留下深刻的印象，即使你的产品没有达到标准。
下面列出了编写出色的 readme.txt 文件的好处。
- 编写良好的 readme.txt 有助于您的插件排名
- 它可以让你向全世界介绍你的插件
- 您可以灵活运用产品的惊人功能
- 它向潜在用户介绍安装过程
- 它为用户可能遇到的最常见问题提供答案
- readme.txt 可以链接到您的网站和其他产品
- 您可以巧妙地追加销售您的产品和服务
现在，你知道好处了。 让我们学习如何编写一个出色的 readme.txt 文件。
如何为您的 WordPress 插件创建 Readme.txt 文件
readme.txt 文件通常包含标题信息、描述、FAQ、屏幕截图和其他信息。 以下部分有关于如何完美地编写每个部分的精确而简洁的指导。 继续阅读以了解为您的 WordPress 插件编写 readme.txt 文件的艺术。
1. 了解什么是 Markdown 语法
编写 readme.txt 时需要遵循 markdown 语法。 Markdown 是指将纯文本转换为 HTML 的纯文本格式化系统。 您可以从 John Gruber 开发的 Daring Fireball 项目中了解有关 Markdown 语法的更多信息。
让我们看看 Markdown 如何通过以下示例将文本翻译成 HTML。
Markdown文字：
A First Level Header
====================
A Second Level Header
---------------------
Now is the time for all good men to come to
the aid of their country. This is just a
regular paragraph.
The quick brown fox jumped over the lazy
dog's back.
### Header 3
> This is a blockquote.
>
> This is the second paragraph in the blockquote.
>
> ## This is an H2 in a blockquote以 HTML 格式输出：
<h1>A First Level Header</h1>
<h2>A Second Level Header</h2>
<p>Now is the time for all good men to come to
the aid of their country. This is just a
regular paragraph.</p>
<p>The quick brown fox jumped over the lazy
dog's back.</p>
<h3>Header 3</h3>
<blockquote>
<p>This is a blockquote.</p>
<p>This is the second paragraph in the blockquote.</p>
<h2>This is an H2 in a blockquote</h2>
</blockquote>了解 markdown 的用法是学习如何创建 readme.txt 文件的第一步。 关注此资源，了解 MARKDOWN 格式语法的基础知识。
2. 包括所有必需的自述文件头信息
您应该将以下信息添加到插件自述文件标题中。
Plugin Name：只需写下插件的唯一名称。确保您的给定名称不与 WordPress 存储库中可用的任何现有名称重叠。类似的名称将在未来产生冲突。
Contributors：感谢帮助您开发产品的人。这应该是 WordPress.org 用户名列表。除了 WordPress 用户名之外的任何其他内容都将显示为带有 gravatar 的无个人资料链接。用逗号分隔每个名称。
Donate link：这部分是可选的。您可以添加指向您的个人资料或任何最终导致付款选项的资源的链接。
Tags：将关键字保留为标签。用逗号分隔每个标签。您最多可以放置 12 个标签。除此之外的任何事情都会损害您的搜索引擎优化。建议保留 5 个标签，因为只有前五个标签会出现在生成的页面上。
Tested up to：WordPress 经常发布其改进版本。在此字段中包含您的产品已针对其进行测试的版本号。该字段应仅包含数字。例如，您应该只写“6.3”而不是写“WordPress 6.3”。
Requires PHP：此部分是可选的。您需要添加与您的插件兼容的最低 PHP 版本。和上面一样，这里只需要写版本号。
Stable Tag：在这里写下你的插件的稳定版本号。不要将此数字与 PHP 或 WordPress 版本混淆，它仅适用于您的插件。您可以查看 SemVer 格式化系统以了解如何编写稳定的标签。
License：所有 WordPress 插件都自动遵守 GNU 通用公共许可证的条款和条件。您需要在此处添加此信息。
License URL：这是另一个可选字段。放置一个指向包含有关您的许可证的详细信息的资源的链接。如果您的插件使用不太熟悉的许可证，您应该添加此部分。
完成标题信息后，您可以进行下一步 - 简短描述和长描述。
3.写一个简洁准确的简短描述
在标题部分之后，有一个专门的部分用于对您的插件进行简短描述。 您不能在本节中使用标记。 保持简短的描述重点和不言自明。 字符限制为 150。任何超过此限制的内容将被切断。
4. 保持长描述的相关性
在这里你可以自由地解释你的插件可以做什么，为什么人们应该使用它，以及插件的其他技术细节和规范。
不要忘记包括吸引潜在客户的关键功能和独特卖点。 以下是编写有效的长描述的一些技巧：
- 使用markdown添加多种编队
- 帮助关键特征从其他文本中脱颖而出
- 添加指向您的产品的特色来源的链接
- 添加指向重要文档和博客的链接
- 如果您有任何特色视频
- 通知用户即将推出的功能
- 您可以包含指向您的社交媒体或网站的链接
查看 Dokan Multivendor 的这个示例，查看出色的长描述的真实演示。
5.添加安装过程说明
写下人们如何手动和从 WordPress 存储库搜索结果安装您的插件。 如果您的插件遵循 WordPress 的常规安装过程，您可以跳过此步骤。 但是，如果您的插件具有自定义安装设置，则此部分是必须的。
6.包括一个常见问题解答部分
设身处地为用户着想。 尝试了解他们的痛点以及他们可能对您的产品有什么疑问。 他们在此常见问题解答部分中汇总了所有这些问题。 您应该在此处包含所有常见问题。
顺便说一句，只有常见问题解答不能为所有独特的问题提供答案。 因此，最好通过 WordPress 的支持论坛和您的个人票务系统提供支持。
7.添加截图帮助用户
屏幕截图作为插件的主要阈值。 您应该添加真实图像以帮助用户了解您的插件在运行时的外观。 这些图像也为潜在用户提供了有关 UI 和 UX 的提示。 因此，添加屏幕截图以吸引用户至关重要。
8. 如果您需要，请提供其他信息
您应该在本节中包含变更日志、升级通知和其他附加信息。 按照 markdown 语法指南正确显示所有信息。 不要添加不是真正必要的信息。 由于信息过多，用户可能会分心并错过重要信息。
WordPress 插件的标准 Readme.txt 文件示例
WordPress.org 提供了一个示例自述文件来帮助每个人生成一个编写良好的自述文件。 请看以下示例：
=== Plugin Name ===
Contributors: (this should be a list of wordpress.org userid's)
Donate link: https://example.com/
Tags: tag1, tag2
Requires at least: 4.7
Tested up to: 5.4
Stable tag: 4.3
Requires PHP: 7.0
License: GPLv2 or later
License URI: https://www.gnu.org/licenses/gpl-2.0.html
Here is a short description of the plugin. This should be no more than 150 characters. No markup here.
== Description ==
This is the long description. No limit, and you can use Markdown (as well as in the following sections).
For backwards compatibility, if this section is missing, the full length of the short description will be used, and
Markdown parsed.
A few notes about the sections above:
* "Contributors" is a comma separated list of wordpress.org usernames
* "Tags" is a comma separated list of tags that apply to the plugin
* "Requires at least" is the lowest version that the plugin will work on
* "Tested up to" is the highest version that you've *successfully used to test the plugin*
* Stable tag must indicate the Subversion "tag" of the latest stable version
Note that the `readme.txt` value of stable tag is the one that is the defining one for the plugin. If the `/trunk/readme.txt` file says that the stable tag is `4.3`, then it is `/tags/4.3/readme.txt` that'll be used for displaying information about the plugin.
If you develop in trunk, you can update the trunk `readme.txt` to reflect changes in your in-development version, without having that information incorrectly disclosed about the current stable version that lacks those changes -- as long as the trunk's `readme.txt` points to the correct stable tag.
If no stable tag is provided, your users may not get the correct version of your code.
== Frequently Asked Questions ==
= A question that someone might have =
An answer to that question.
= What about foo bar? =
Answer to foo bar dilemma.
== Screenshots ==
1. This screen shot description corresponds to screenshot-1.(png|jpg|jpeg|gif). Screenshots are stored in the /assets directory.
2. This is the second screen shot
== Changelog ==
= 1.0 =
* A change since the previous version.
* Another change.
= 0.5 =
* List versions from most recent at top to oldest at bottom.
== Upgrade Notice ==
= 1.0 =
Upgrade notices describe the reason a user should upgrade. No more than 300 characters.
= 0.5 =
This version fixes a security related bug. Upgrade immediately.
== A brief Markdown Example ==
Markdown is what the parser uses to process much of the readme file.
[markdown syntax]: https://daringfireball.net/projects/markdown/syntax
Ordered list:
1. Some feature
1. Another feature
1. Something else about the plugin
Unordered list:
* something
* something else
* third thing
Links require brackets and parenthesis:
Here's a link to [WordPress](https://wordpress.org/ "Your favorite software") and one to [Markdown's Syntax Documentation][markdown syntax]. Link titles are optional, naturally.
Blockquotes are email style:
> Asterisks for *emphasis*. Double it up for **strong**.
And Backticks for code:
`<?php code(); ?>`由于此示例 readme.txt 是 WordPress.org 推荐的，因此您可以仔细阅读。 如果您能完美地模仿样本，插件审核团队将批准您的插件。
使用 WordPress 自述文件生成器工具来避免麻烦
使用 WordPress 的乐趣在于，您几乎可以在工具的帮助下完成所有工作。 它有几乎所有东西的工具。 readme.txt 的情况也不例外。 有许多有用的自述文件生成器工具。 您可以使用 weDevs 的 WP Readme Generator 为您的插件创建一个 readme.txt 文件。
该工具非常易于使用。 从左侧边栏中选择选项。 每个选项都会为您扩展特定的输入字段。 然后在那里写你的内容。 您将在屏幕上看到实时输出。 有关示例，请参见下一张图片。
您可以使用 weDevs 开发的此工具导入和导出您的 readme.txt 文件。 我遇到了另一个可以帮助您的有用工具。 如果您想为您的产品创建出色的自述文件，也可以使用 GenerateWP 自述文件生成器。
完成 readme.txt 的编写后，检查它是否正常并符合标准的 WordPress 实践。 使用 URL 或将文本粘贴到文本框中来验证您的插件。
额外提示–如何优化您的 WordPress SEO 插件
除了通常的关键字和 slug 之外，WordPress.org 在对插件进行排名时还会考虑更多因素。 保持您的支持线程活跃意味着尽快解决问题。
查看以下可操作的提示，以提高您在 WordPress 存储库和 Google 中的排名。
- 在插件名称中包含关键字
- 推送定期更新（即使是次要更新）
- 使您的插件与最新的 WordPress 和 PHP 版本兼容
- 选择与您的目标关键字匹配的标签
- 在常见问题解答中插入相关关键字（尽可能）
- 尝试提高产品的平均评分
- 加入更多活跃用户（活跃安装影响排名）
- 编写一个完整的 readme.txt，其中包含正确的关键字
如何为您的插件获得良好的平均评分（仅限初学者）
和你一样，我也想过在部署我的产品后如何才能获得良好的评价。每个问题都有解决方案。您可以联系参与 WordPress 的朋友、同事和家人。要求他们使用您的插件并留下 5 星评价。
它将为您提供最初的提升。如果您的产品缺乏质量，从长远来看，您将失败。这些后门审查仅在初始阶段带来了良好的效果。仅仅依靠黑帽技术是不可能在市场上维持你的插件的。
最后的想法
因此，在为 WordPress 创建有效的 Readme.txt 文件之前，这就是您需要了解的全部内容。
我们相信上述步骤、最佳实践和技巧将帮助您使您的插件更好地被搜索引擎读取。
如果您有任何问题或进一步的疑问，请不要忘记在评论部分告诉我们。干杯!
