README.md

Documentation Overview

This folder contains usage guides for the PowerShell modules and commands provided in this repository. Each Markdown file describes a single function or provides general guidance. When in doubt, run Get-Help <Command> in PowerShell to see the inline help that matches these documents.

The key guides are:

• Quickstart – short steps to install the modules and run common commands.
• User Guide – detailed deployment information and security notes.
• SupportTools, SharePointTools, ServiceDeskTools, MonitoringTools, ChaosTools – high level summaries of each module and the commands they expose.
• Credential Storage – recommended approach to store secrets securely.
• Module Style Guide – how scripts display progress messages and log output.
• PerformanceTools – measure execution time and resource usage.
• Invoke-PerformanceAudit – collect system metrics and optionally create a Service Desk ticket.
• Telemetry Metrics – summarize execution statistics and output to CSV or SQLite.
• Get-FunctionDependencyGraph – generate a visual map of function calls in a script.
• Local Mock API – run a lightweight HTTP server for offline tests.
• Testing Guidelines – conventions for writing robust Pester tests.
• Stewardship – how to maintain and hand off the project.
• Roadmap – upcoming features and goals.

Command specific help topics live in the SupportTools, SharePointTools and ServiceDeskTools subfolders.

Module Dependency Overview

Most modules build on a few shared components. Logging is the base layer for consistent output and is imported by nearly every module. The Telemetry module records usage metrics and depends on Logging. STCore provides common utility functions consumed across the toolkit.

Higher level modules such as SharePointTools and ServiceDeskTools load these core modules to perform their work. Modules like ConfigManagementTools and IncidentResponseTools combine features from both SharePointTools and ServiceDeskTools, while also using Telemetry for metrics. The SupportTools module aggregates the entire collection and exposes the top level commands.

graph TD
    Logging --> Telemetry
    Logging --> SharePointTools
    Logging --> ServiceDeskTools
    Logging --> PerformanceTools
    Telemetry --> ServiceDeskTools
    SharePointTools --> ConfigManagementTools
    ServiceDeskTools --> ConfigManagementTools
    ConfigManagementTools --> SupportTools
    SharePointTools --> IncidentResponseTools
    ServiceDeskTools --> IncidentResponseTools
    IncidentResponseTools --> SupportTools
    Telemetry --> IncidentResponseTools
    Telemetry --> ConfigManagementTools

Loading

This diagram is a simplified view but highlights how foundational modules feed into higher level functionality.