Skip to content

Commit 72799ff

Browse files
packtmanDipen ShahDipen Shah
authored
Add comprehensive cheat sheet creation guide (GUIDELINE.md) (#1768)
* Add comprehensive cheat sheet creation guide (GUIDELINE.md) and update documentation references * Fix linting issues * Fix linting issues * Remove maintenance and peer review sections, streamline guide structure * Fix code block formatting in template examples * Remove title and other parts from section 4.1 * Simplify GUIDELINE.md based on PR feedback - Focus on basic template - Remove excessive content and keep it simple * Remove section numbering from Advanced Template Features * CHanges per new feedback * Simplify conclusion section in GUIDELINE.md * simplify text in GUIDELINE.md and CONTRIBUTING.md * Fix markdown linting issues in GUIDELINE.md --------- Co-authored-by: Dipen Shah <[email protected]> Co-authored-by: Dipen Shah <[email protected]>
1 parent 071ff3c commit 72799ff

File tree

3 files changed

+248
-1
lines changed

3 files changed

+248
-1
lines changed

‎CONTRIBUTING.md‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -60,6 +60,8 @@ When submitting changes in a PR, consider the following areas:
6060

6161
### Structure
6262

63+
> **Need help with content structure?** Check out [How To Make A Cheatsheet guide](GUIDELINE.md) for structured guidelines, content organization, and best practices.
64+
6365
- Start with a H1 of the cheat sheet name
6466
- The first section of the cheat sheet should be an introduction which briefly sums up the contents, and provides a short list of key bullet points.
6567
- The table of contents will be automatically generated on the site, so does not need to be added as a section.

‎GUIDELINE.md‎

Lines changed: 245 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,245 @@
1+
# Cheat Sheet Creation Guide
2+
3+
## Basic Cheat Sheet Template
4+
5+
```markdown
6+
7+
# [Topic] Cheat Sheet
8+
9+
## Introduction
10+
11+
Brief overview of the topic, its importance in application security, and target audience.
12+
13+
## Table of Contents
14+
15+
- [Background](#background)
16+
- [Threat Analysis](#threat-analysis)
17+
- [Prevention Strategies](#prevention-strategies)
18+
- [Implementation Guide](#implementation-guide)
19+
- [Testing & Validation](#testing--validation)
20+
- [Monitoring & Maintenance](#monitoring--maintenance)
21+
- [References & Resources](#references--resources)
22+
23+
## Background
24+
25+
### What is [Topic]?
26+
27+
Definition and explanation of the security concept.
28+
29+
### Why is [Topic] Important?
30+
31+
Explanation of why this security topic matters.
32+
33+
### Current Threat Landscape
34+
35+
Overview of current threats and attack vectors.
36+
37+
## Threat Analysis
38+
39+
### Attack Vectors
40+
41+
- Attack Vector 1: Description and examples
42+
- Attack Vector 2: Description and examples
43+
- Attack Vector 3: Description and examples
44+
45+
### Vulnerability Types
46+
47+
- Vulnerability Type 1: Description and impact
48+
- Vulnerability Type 2: Description and impact
49+
- Vulnerability Type 3: Description and impact
50+
51+
### Risk Assessment
52+
53+
- High Risk: Critical vulnerabilities and their impact
54+
- Medium Risk: Moderate vulnerabilities and their impact
55+
- Low Risk: Minor vulnerabilities and their impact
56+
57+
## Prevention Strategies
58+
59+
### Defense in Depth
60+
61+
1. Layer 1: Primary defense mechanism
62+
2. Layer 2: Secondary defense mechanism
63+
3. Layer 3: Tertiary defense mechanism
64+
65+
### Best Practices
66+
67+
- Best Practice 1: Description and implementation
68+
- Best Practice 2: Description and implementation
69+
- Best Practice 3: Description and implementation
70+
71+
## Implementation Guide
72+
73+
### Step-by-Step Implementation
74+
75+
#### Step 1: Preparation
76+
77+
language
78+
// Code example for step 1
79+
80+
81+
#### Step 2: Configuration
82+
83+
language
84+
// Code example for step 2
85+
86+
87+
#### Step 3: Validation
88+
89+
language
90+
// Code example for step 3
91+
92+
93+
### Framework-Specific Implementation
94+
95+
#### Framework A
96+
97+
language
98+
// Framework A specific implementation
99+
100+
101+
#### Framework B
102+
103+
language
104+
// Framework B specific implementation
105+
106+
107+
## Testing & Validation
108+
109+
### Testing Methods
110+
111+
- Method 1: Description and tools
112+
- Method 2: Description and tools
113+
- Method 3: Description and tools
114+
115+
### Validation Checklist
116+
117+
- [ ] Check 1: Description
118+
- [ ] Check 2: Description
119+
- [ ] Check 3: Description
120+
121+
### Tools & Utilities
122+
123+
- Tool 1: Description and usage
124+
- Tool 2: Description and usage
125+
- Tool 3: Description and usage
126+
127+
## Monitoring & Maintenance
128+
129+
### Ongoing Monitoring
130+
131+
- Metric 1: What to monitor and how
132+
- Metric 2: What to monitor and how
133+
- Metric 3: What to monitor and how
134+
135+
### Maintenance Tasks
136+
137+
- Task 1: Frequency and procedure
138+
- Task 2: Frequency and procedure
139+
- Task 3: Frequency and procedure
140+
141+
### Incident Response
142+
143+
- Detection: How to detect issues
144+
- Response: How to respond to issues
145+
- Recovery: How to recover from issues
146+
147+
## References & Resources
148+
149+
### Further Reading
150+
151+
- [Resource 1](link): Description
152+
- [Resource 2](link): Description
153+
- [Resource 3](link): Description
154+
155+
### Tools & Utilities
156+
157+
- [Tool 1](link): Description
158+
- [Tool 2](link): Description
159+
- [Tool 3](link): Description
160+
161+
### Standards & Frameworks
162+
163+
- [Standard 1](link): Description
164+
- [Standard 2](link): Description
165+
- [Standard 3](link): Description
166+
167+
### Related Cheat Sheets
168+
169+
- [Related Cheat Sheet 1](link): Description
170+
- [Related Cheat Sheet 2](link): Description
171+
- [Related Cheat Sheet 3](link): Description
172+
173+
```
174+
175+
### Advanced Template Features
176+
177+
```markdown
178+
179+
#### Code Comparison Tables
180+
181+
| Aspect | Secure Implementation | Vulnerable Implementation |
182+
|--------|---------------------|---------------------------|
183+
| Input Validation | `validateInput(input)` | `raw_input()` |
184+
| Output Encoding | `html.escape(output)` | Direct output |
185+
| Authentication | `verifyToken(token)` | No verification |
186+
187+
#### Risk Assessment Matrix
188+
189+
| Threat | Likelihood | Impact | Risk Level |
190+
|--------|------------|--------|------------|
191+
| Threat 1 | High | High | Critical |
192+
| Threat 2 | Medium | High | High |
193+
| Threat 3 | Low | Medium | Medium |
194+
195+
#### Implementation Checklist
196+
197+
### Implementation Checklist
198+
199+
#### Preparation
200+
- [ ] Review security requirements
201+
- [ ] Identify target environment
202+
- [ ] Gather necessary tools
203+
204+
#### Implementation
205+
- [ ] Configure security settings
206+
- [ ] Implement validation logic
207+
- [ ] Test functionality
208+
209+
#### Validation
210+
- [ ] Run security tests
211+
- [ ] Verify configurations
212+
- [ ] Document changes
213+
```
214+
215+
---
216+
217+
## Conclusion
218+
219+
This guideline helps you to create security guidance that helps practitioners implement effective security controls.
220+
221+
### Key Success Factors
222+
223+
1. **Clear Scope**: Define what you're covering and what you're not
224+
2. **Practical Focus**: Emphasize actionable guidance over theory
225+
3. **Comprehensive Coverage**: Address all major aspects of the topic
226+
4. **Current Information**: Keep content up-to-date with latest threats and defenses
227+
5. **Community Engagement**: Gather feedback and continuously improve
228+
6. **Quality Assurance**: Thorough review and testing of all content
229+
230+
### Next Steps
231+
232+
1. **Choose Your Topic**: Select a security domain that needs coverage
233+
2. **Research Existing Content**: Review current cheat sheets and identify gaps
234+
3. **Plan Your Structure**: Use the templates provided to organize your content
235+
4. **Develop Content**: Write comprehensive, practical guidance
236+
5. **Review & Test**: Validate technical accuracy and usability
237+
6. **Publish & Maintain**: Share with community and keep updated
238+
239+
### Remember
240+
241+
The goal is to create **practical, concise, and actionable security guidance** that helps practitioners build more secure applications and systems. Focus on providing value to your target audience and maintaining high quality standards.
242+
243+
---
244+
245+
*This guide is based on analysis of existing OWASP cheat sheets to identify common patterns and best practices for creating effective security documentation.*

‎README.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ Feel free to ask questions, suggest ideas, or share your best recipes.
3232

3333
## Contributions, Feature Requests, and Feedback
3434

35-
We are actively inviting new contributors! To start, please read the [contribution guide](CONTRIBUTING.md).
35+
We are actively inviting new contributors! To start, please read the [contribution guide](CONTRIBUTING.md) and our [How To Make A Cheatsheet guide](GUIDELINE.md).
3636

3737
This project is only possible thanks to the work of many dedicated volunteers. Everyone is encouraged to help in ways large and small. Here are a few ways you can help:
3838

0 commit comments

Comments
 (0)