Skip to content

Commit db62151

Browse files
author
Brent Cook
committed
Land rapid7#8030, update the module doc template
2 parents a910f38 + da1e58d commit db62151

File tree

1 file changed

+7
-4
lines changed

1 file changed

+7
-4
lines changed

documentation/modules/module_doc_template.md

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,17 @@
11
The following is the recommended format for module documentation.
22
But feel free to add more content/sections to this.
3-
3+
One of the general ideas behind these documents is to help someone troubleshoot the module if it were to stop
4+
functioning in 5+ years, so giving links or specific examples can be VERY helpful.
45

56
## Vulnerable Application
67

7-
Instructions to get the vulnerable application.
8+
Instructions to get the vulnerable application. If applicable, include links to the vulnerable install files,
9+
as well as instructions on installing/configuring the environment if it is different than a standard install.
10+
Much of this will come from the PR, and can be copy/pasted.
811

912
## Verification Steps
1013

11-
Example steps in this format:
14+
Example steps in this format (is also in the PR):
1215

1316
1. Install the application
1417
2. Start msfconsole
@@ -20,7 +23,7 @@ But feel free to add more content/sections to this.
2023

2124
**Option name**
2225

23-
Talk about what it does, and how to use it appropriately.
26+
Talk about what it does, and how to use it appropriately. If the default value is likely to change, include the default value here.
2427

2528
## Scenarios
2629

0 commit comments

Comments
 (0)