pwn.guide
Docs
Content Guidelines

Content Guidelines

Standards for writing and formatting tutorials for pwn.guide.

This guide provides standards for creating high-quality tutorials for pwn.guide. Follow these guidelines to ensure your submission meets our quality standards.

Writing Standards

Clarity and Accessibility

  • Write for readers with basic computer knowledge
  • Explain technical jargon when first used
  • Use clear, concise language
  • Structure content logically from simple to complex
  • Break content into digestible sections
  • Be specific with exact commands and expected outputs

Technical Accuracy

  • Test all commands before submission
  • Verify on clean, updated systems
  • Document exact tool versions used
  • Include screenshots of key steps
  • Acknowledge limitations
  • Provide troubleshooting steps

Content Structure

Required Sections

1. Title - Clear, descriptive (under 60 characters)

  • ✅ "SQL Injection: Exploiting Login Forms with SQLMap"
  • ❌ "Hacking Tutorial"

2. Introduction - Brief overview (2-3 paragraphs) explaining what will be learned and why

3. Prerequisites

  • Required knowledge level
  • Necessary tools and software
  • System requirements
  • Prior tutorials to complete (if any)

4. Main Content

  • Step-by-step instructions
  • Clear section headings
  • Code blocks for commands
  • Explanations of what each step does

5. Troubleshooting - Common errors and solutions

6. Conclusion - Summary, practical applications, next steps

Optional Sections

  • Lab setup instructions
  • Background theory
  • Advanced techniques
  • References and additional resources

Markdown Formatting

Basic Formatting

# H1 - Tutorial Title
## H2 - Major Sections
### H3 - Subsections
 
**Bold** for important terms
*Italic* for emphasis
`code` for inline commands
 
- Unordered lists
1. Ordered lists

Code Blocks

```bash
# Command with comment
nmap -sV 192.168.1.1
```
 
Expected output:
```
PORT    STATE SERVICE VERSION
22/tcp  open  ssh     OpenSSH 7.4
```

Links and Special Elements

[Internal Link](/docs/tutorials)
[External Link](https://example.com)
 
<Callout>
 
**Important**: Always get permission before testing.
 
</Callout>

Content Best Practices

Commands and Code

Always include:

  • Full command syntax with parameters
  • Expected output
  • Explanation of what command does
  • Why you're using it

Example:

Scan the target for open ports:
```bash
nmap -sV -sC 192.168.1.1

The -sV flag detects service versions, -sC runs default scripts.


### Ethical Guidelines

Always include legal disclaimer:

```markdown
<Callout>

**Legal Notice**: Educational purposes only. Only test on systems you own or have explicit permission to test.

</Callout>

Emphasize:

  • Get authorization first
  • Use for legitimate purposes only
  • Follow responsible disclosure
  • Respect privacy and laws

Technical Writing Tips

Be Concise

  • ❌ "In order to proceed, you will need to execute the command that runs Nmap."
  • ✅ "Run Nmap:"

Use Active Voice

  • ❌ "The vulnerability can be exploited by sending a request."
  • ✅ "Send a request to exploit the vulnerability."

Provide Context

  • ❌ "Run: nmap 192.168.1.1"
  • ✅ "Scan the target: nmap 192.168.1.1"

Quality Checklist

Before submitting, verify:

Content

  • Clear title and introduction
  • Prerequisites listed
  • Steps in logical order
  • Commands tested and working
  • Troubleshooting included
  • Ethical considerations addressed

Technical

  • All commands verified
  • Tool versions documented
  • Screenshots current
  • Known limitations noted

Formatting

  • Proper Markdown syntax
  • Code blocks with language tags
  • Hierarchical headings
  • Working links
  • No typos

Common Mistakes to Avoid

Too Vague

  • ❌ "Hack the website"
  • ✅ "Exploit SQL injection in the login form"

Missing Steps

  • ❌ "Install the tools and run the attack"
  • ✅ "1. Install Kali... 2. Update repos... 3. Install SQLMap..."

No Explanations

  • ❌ Just listing commands
  • ✅ Explaining what each does and why

Outdated Content

  • ❌ Using deprecated tools
  • ✅ Using current, maintained tools

Example Tutorial Template

Here's a template structure for a well-formatted tutorial:

Frontmatter:

  • title: [Tutorial Title]
  • description: [Brief description]

Legal Notice Section: Include a callout with "Educational purposes only. Get authorization first."

Main Sections:

  1. Introduction - 2-3 paragraphs explaining what will be learned
  2. Prerequisites - Knowledge (Basic Linux), Tools (Kali Linux, Burp Suite), Requirements (4GB RAM)
  3. Step 1: Setup - Instructions with commands like sudo apt update and explanations
  4. Step 2-N: [Actions] - Continue with detailed steps
  5. Troubleshooting - Common issues and solutions
  6. Conclusion - Summary of key points and next steps
  7. References - Documentation links and related tutorials

Use proper markdown formatting with code blocks for commands, bullet lists for key points, and section headings (##) for each part.

Submission Checklist

Before emailing to write@pwn.guide:

  • Follows all guidelines
  • Quality checklist completed
  • All commands tested
  • Proper Markdown formatting
  • Legal disclaimer included
  • Author information provided
  • Category and difficulty specified
  • File in .md format

Need Help?

Questions: write@pwn.guide Examples: Browse tutorial library Support: support@pwn.guide

Remember: Quality over quantity. One excellent tutorial is better than several mediocre ones.

Related: Submit Tutorials | About Us | Tutorials

Submit TutorialsPrivacy Policy