Documentation

Generate professional compliance documentation in PDF or HTML format.

Create guides for auditors, technical teams, or management with customizable content and branding.

What Does Documentation Do?

Documentation generates comprehensive guides from your compliance baseline. Instead of manually writing documentation, MACE creates professional documents that include rule details, remediation steps, configuration profiles, and compliance references.

Documentation vs Build vs Audit

Build creates deployable files (scripts, profiles, DDM) for your MDM.

Audit checks a Mac's current compliance status.

Documentation creates human-readable guides explaining your compliance requirements.

Output Formats

📄

PDF

Professional document format. Ideal for sharing with auditors, printing for meetings, or archiving compliance documentation. Supports pagination, page numbers, and clickable table of contents.

🌐

HTML

Web-based format. Opens in any browser, easy to share via email, and works well for internal team reference. Self-contained single file with all styles embedded.

Document Types

MACE offers three pre-configured document types, each designed for a different audience:

📋

Compliance Guide

Full documentation for compliance teams and auditors.

• Rule discussions and rationale
• Fix commands and remediation steps
• Configuration profiles and DDM info
• Compliance framework references
• Section summaries with statistics

🔧

Technical Reference

Implementation-focused for IT administrators.

• Check and fix commands
• Configuration profile payloads
• DDM declaration details
• Technical implementation notes
• Command-focused format

📊

Executive Summary

High-level overview for management.

• Compliance scope and coverage
• Key statistics and metrics
• Minimal technical details
• Stakeholder-friendly format
• Quick overview of requirements

Generating Documentation

1

Open your projectLoad a compliance project with your selected baseline and rules

2

Click DocumentationUse the toolbar button to open the Documentation window

3

Select engineChoose M.A.C.E. Documentation (recommended)

4

Choose document typeSelect Compliance Guide, Technical Reference, or Executive Summary

5

Select output formatChoose PDF or HTML

6

Configure optionsCustomize content, structure, and branding

7

Click GenerateChoose where to save and MACE creates your document

Documentation Engines

⚡

M.A.C.E. Documentation Engine

The recommended engine. Fast, full-featured, and built into MACE.

• Professional PDF and HTML output
• Clickable table of contents
• Custom branding and colors
• All content options available

🐍

mSCP Documentation Engine

Uses the original mSCP Python scripts. For organizations already using mSCP command-line tools.

• (Planned for future release)

What's in the Document?

A generated document includes multiple sections organized for easy reference:

📖Cover Page

Document title, compliance framework, version, author, and organization. Sets the professional tone for the document.

📑Table of Contents

Clickable navigation to all sections. Optional detailed view with numbered sections and all rules listed.

📋Foreword & Scope

Introduction explaining what platform and compliance framework the document covers.

📊Section Summaries

Statistics for each section showing total rules, configurable rules, manual rules, and more.

📝Rule Details

Each rule with its ID, title, discussion, commands, profiles, and references. The core content of the document.

🔍Quick Reference Table

Appendix table listing all rules at a glance for quick lookup.

📚Glossary & Acronyms

Definitions of technical terms and abbreviations used in the document.