metasploit-framework/documentation/modules/module_doc_template.md

The following is the recommended format for module documentation. But feel free to add more content/sections to this.

Vulnerable Application

Instructions to get the vulnerable application.

Verification Steps

Example steps in this format:

1. Install the application
2. Start msfconsole
3. Do: use [module path]
4. Do: run
5. You should get a shell.

Options

Option name

Talk about what it does, and how to use it appropriately.

Scenarios

Specific demo of using the module that might be useful in a real world scenario.

code or console output

For example:

To do this specific thing, here's how you do it:

msf > use module_name
msf auxiliary(module_name) > set POWERLEVEL >9000
msf auxiliary(module_name) > exploit