Skip to main content

ScrewDriversKB Documentation Guide

Welcome to the ScrewDrivers Knowledge Base. This documentation follows the Diátaxis framework, organizing content by purpose to help you find exactly what you need.

📖 Documentation Framework​

Our documentation is organized into four main types, each serving a different purpose:

🎓 Tutorials - Learning-oriented​

When to use: You're new to ScrewDrivers and want to learn by doing.

Tutorials provide guided, hands-on learning experiences that help you take your first steps. They're designed for beginners and follow a step-by-step approach to build foundational skills.

What you'll find:

  • Getting started guides
  • Introductory walkthroughs
  • Hands-on exercises with clear outcomes
  • Prerequisites and setup instructions

Example: "Getting Started with ScrewDrivers Essentials"

🔧 How-To Guides - Task-oriented​

When to use: You have a specific task to accomplish.

How-to guides provide practical, goal-oriented instructions for accomplishing specific tasks. They assume you have basic knowledge and focus on solving real-world problems.

What you'll find:

  • Installation - Setup and deployment guides
  • Configuration - System and feature configuration
  • Troubleshooting - Solving specific problems
  • General - Common tasks and procedures

Example: "How to Configure Print Server Load Balancing"

📚 Reference - Information-oriented​

When to use: You need precise technical details or specifications.

Reference documentation provides comprehensive technical information, specifications, and detailed descriptions. Use this when you need to look up specific details.

What you'll find:

  • Admin Guide - Complete administration reference
  • User Guide - End-user documentation
  • Technical Manual - Specifications and technical details
  • API documentation
  • Configuration options
  • Command references

Example: "ScrewDrivers Admin Console Configuration Reference"

💡 Explanation - Understanding-oriented​

When to use: You want to understand concepts, architecture, or the "why" behind features.

Explanations provide context, background, and deeper understanding of concepts. They help you comprehend the broader picture and design decisions.

What you'll find:

  • Overview - Product overviews and introductions
  • Concepts - Core concepts and principles
  • Architecture - System design and architecture
  • Design rationale
  • Best practices and recommendations

Example: "Understanding ScrewDrivers Print Queue Architecture"

📋 Additional Sections​

🐛 Known Issues​

Current bugs, limitations, and workarounds for known problems.

📝 Release Notes​

Version history, changelogs, and what's new in each release.

🧭 Finding What You Need​

By Role​

Your RoleStart Here
New AdministratorTutorials → How-To: Installation → Admin Guide
Experienced AdminHow-To Guides → Reference
End UserUser Guide → How-To Guides
Architect/DesignerExplanation → Technical Manual
TroubleshooterHow-To: Troubleshooting → Known Issues

By Need​

What You NeedWhere to Look
Learn the basicsTutorials
Solve a specific problemHow-To Guides
Look up technical detailsReference
Understand how things workExplanation
Find version changesRelease Notes
Check for bugsKnown Issues

By Product Edition​

ScrewDrivers Essentials:

  • Endpoint printing and scanning
  • Basic administration
  • Client deployment

ScrewDrivers Pro & Enterprise:

  • Advanced features (Print Server, Admin Console, etc.)
  • Enterprise management
  • Load balancing and high availability

💡 Documentation Tips​

For Best Results:​

  1. Start Broad, Then Narrow

    • Begin with explanations or tutorials if you're new
    • Move to how-to guides for specific tasks
    • Use reference for detailed lookups

  2. Use Search Effectively

    • Search for specific error messages in troubleshooting
    • Look for feature names in reference docs
    • Find concepts in explanation section

  3. Follow Prerequisites

    • Check tutorial prerequisites before starting
    • Review related concepts in explanations
    • Verify system requirements in installation guides

  4. Bookmark Frequently Used Pages

    • Save your edition-specific guides
    • Mark troubleshooting pages you reference often
    • Keep configuration references handy

📐 Diátaxis Framework​

This documentation follows the Diátaxis framework, which organizes content around user needs:

                    Most Useful When...
          Learning            Working
        ↓                           ↓
Practical → TUTORIALS    HOW-TO GUIDES
Understanding → EXPLANATION   REFERENCE
  • Tutorials = Learning + Practical
  • How-To = Working + Practical
  • Explanation = Learning + Understanding
  • Reference = Working + Understanding

Learn more about this framework at diataxis.fr.

🆘 Getting Help​

Documentation Issues​

Found a problem with the documentation? Please report:

  • Broken links
  • Outdated information
  • Unclear instructions
  • Missing content

Product Support​

For product-specific support:

  • Check Troubleshooting Guides
  • Review Known Issues
  • Consult edition-specific Reference Documentation

📊 Documentation Statistics​

  • Total Documents: 589 markdown files
  • Framework: Diátaxis (4 content types)
  • Editions Covered: Essentials, Pro, Enterprise
  • Last Updated: October 2, 2025

Navigation Tip: Use the sidebar to browse by category, or the search function to find specific topics quickly.