From ff49a2a44008552b940f0bec5af6ec2d87f817e1 Mon Sep 17 00:00:00 2001
From: Peter Mosmans <support@go-forward.net>
Date: Tue, 4 Oct 2016 16:59:55 +1000
Subject: [PATCH] Added more explanation about the attributes

---
 xml/templates/pentestreport/finding.xml | 16 +++++++++++++++-
 1 file changed, 15 insertions(+), 1 deletion(-)

diff --git a/xml/templates/pentestreport/finding.xml b/xml/templates/pentestreport/finding.xml
index 2925744..8b2f3f5 100644
--- a/xml/templates/pentestreport/finding.xml
+++ b/xml/templates/pentestreport/finding.xml
@@ -1,5 +1,19 @@
 <finding id="..." threatLevel="Moderate" type="Information Leak">
-  <!-- Note: threatLevel can be Low, Moderate, Elevated, High or Extreme; type is free text -->
+
+  <!--
+      id needs to be unique across the report, preferably identical to the filename
+      (without extension).
+
+      threatLevel can be Low, Moderate, Elevated, High or Extreme.
+
+      type is the root cause, written in Title Case.
+
+        Examples: Easily Guessable Credentials
+                  Lack Of Application Hardening
+                  Lack Of Webserver Hardening
+                  Missing Patch
+                  Network Design Flaw
+  -->
 
   <title>Title Case</title>