📖 User Guide

Complete guide to using Linterman - from basics to advanced features.

📋 Table of Contents

• What is Linterman?
• Getting Started
• Understanding Results
• Auto-Fix Feature
• Downloading Collections
• Best Practices

🎯 What is Linterman?

Linterman is a powerful tool for analyzing and automatically fixing Postman collections. It detects quality issues, calculates a score, and can fix up to 65% of problems automatically.

Key Features

• ✅ Instant Analysis: Results in <1 second
• ✅ Auto-Fix: 65% of issues fixed automatically
• ✅ 100% Private: Collections never leave your browser
• ✅ Free: No account required
• ✅ Direct Export: Download and import to Postman

🚀 Getting Started

See the Quick Start Guide for a 2-minute introduction.

📊 Understanding Results

Score Calculation

Score = 100% - (penalties) + (bonus)

Penalties:

• ❌ ERROR: -15% per issue
• ⚠️ WARNING: -8% per issue
• ℹ️ INFO: -3% per issue

Bonus:

• ✨ +5% if 0 errors AND ≤ 2 warnings

🔧 Auto-Fix Feature

The auto-fix feature can automatically correct 5 types of issues:

1. Request naming convention
2. Missing HTTP status tests
3. Missing response time tests
4. Test descriptions without URI
5. High response time thresholds

📥 Downloading Collections

💡 Best Practices

• ✅ Use auto-fix regularly
• ✅ Add documentation as you go
• ✅ Test every request
• ✅ Use environment variables
• ✅ Follow naming conventions

📚 Next Steps