> ## Documentation Index
> Fetch the complete documentation index at: https://docs.xray.cool/llms.txt
> Use this file to discover all available pages before exploring further.

# 文档使用方法

> 欢迎阅读我们的文档！本文档将指导您了解如何有效地使用我们的文档以便快速上手

## 环境（Environment）

建议先访问[编写环境配置](/plugins/Environment)，配置好编写环境，这将对编写插件有很大的帮助

## 初学者（Beginner）

1. 请先访问[快速开始](/plugins/QuickStart)，尝试编写您的第一个插件，并尝试运行起来吧，有的时候，得先学会跑步，才能学会走路。
2. 成功后，可以查看YAML插件介绍相关的内容，去了解插件的细节，在这个过程中，可以使用[规则实验室](https://poc.xray.cool)作为辅助理解，了解http请求与poc字段间的关系

## 进阶（Advanced）

当学会了基本的插件编写规则后，开始自己编写POC了，推荐先去看看[POC编写示例](/plugins/practice/poc/Example)，其中完整的讲解了怎么从一个漏洞情报到高质量漏洞的全过程
然后根据自己想要编写的漏洞的类型，在侧边栏里找到对应的类型，并查看详细的编写教程，比如SQL注入，就跳转到[SQL注入](/plugins/practice/poc/SQLInjection)

## 代码示例（Code example）

本文档包含许多代码示例，以帮助您更好地理解各种功能和用法。您可以直接复制这些代码示例，然后在您的环境中运行，以便更好地理解这些示例。

* [**POC编写模板**](/plugins/practice/poc/Template)

## 类型与函数（Types and Functions）

此处包含了全部的类型与函数，您可以在编写YAML遇到使用问题时进行查看

* [**YAML插件的参数类型与函数**](/plugins/yaml/YAMLTypeFunc)

点击函数后面的🔎即可查看函数详情，使用案例：

<img className="block dark:hidden" src="https://mintcdn.com/chaitin-1/95WTb7ivJEg4zZl4/images/plugins/yaml/bsubmatch-light.png?fit=max&auto=format&n=95WTb7ivJEg4zZl4&q=85&s=bc1b9a64aa76da3aa39d68dbcdcb72ca" width="737" height="804" data-path="images/plugins/yaml/bsubmatch-light.png" />

<img className="hidden dark:block" src="https://mintcdn.com/chaitin-1/95WTb7ivJEg4zZl4/images/plugins/yaml/bsubmatch-dark.png?fit=max&auto=format&n=95WTb7ivJEg4zZl4&q=85&s=7eb7c9bb7aee20d98aa0fba8bd99e147" width="741" height="822" data-path="images/plugins/yaml/bsubmatch-dark.png" />

祝您学习愉快！希望本文档能为您提供所需的帮助，助您更好地掌握开发插件的相关知识和技能。如有任何疑问或建议，请随时与我们联系，我们将竭诚为您提供支持。