Author: Adrian Johnson [email protected]
Version: 1.0
Last Updated: October 20, 2025
This directory contains comprehensive documentation for the M&A Technical Discovery Script. Start here to find what you need.
| Document | Description | Audience |
|---|---|---|
| Quick Start Guide | Get up and running in 5 minutes | All Users |
| Installation Guide | Detailed setup and prerequisites | IT Administrators |
| User Guide | Complete usage instructions | Consultants, Auditors |
| Troubleshooting Guide | Common issues and solutions | Support Teams |
| Module Reference | Technical API documentation | Developers |
| Document | Description | Audience |
|---|---|---|
| Design Document | Architecture and technical design | Architects, Developers |
| Development Progress | Build history and features | Project Stakeholders |
| AD Performance Tuning Guide | Microsoft AD performance optimization | Performance Engineers, Architects |
👉 Start with Quick Start Guide
📖 Then read User Guide
👉 Start with Installation Guide
🔧 Keep Troubleshooting Guide handy
👉 Review Design Document
📚 Reference Module Reference
⚡ Check AD Performance Tuning Guide
👉 Read Development Progress
📊 Focus on value metrics and deliverables
Q: How long does the audit take?
A: 30-90 minutes for a medium environment (500 users, 50 servers, 10 SQL instances). See User Guide for details.
Q: What permissions do I need?
A: Domain Admin (on-prem) + Global Reader (M365). See Installation Guide for full requirements.
Q: Is the data encrypted?
A: Yes! Three encryption methods available (EFS, Archive, Azure Key Vault). See User Guide - Security section.
Q: The GUI isn't launching - help!
A: Check Troubleshooting Guide for common issues and solutions.
Q: Can I customize the reports?
A: Yes! See Module Reference for customization options.
Questions? Check the Troubleshooting Guide first.
Found a bug? See CONTRIBUTING.md for how to report issues.
Want to contribute? Review Design Document to understand the architecture.
Throughout this documentation:
- ✅ Green checkmarks indicate completed features
⚠️ Yellow warnings highlight important notes- 🚨 Red alerts mark critical security considerations
- 💡 Light bulbs provide helpful tips
- 📝 Notes offer additional context
- 🔐 Locks indicate security-related content
Code blocks use PowerShell syntax highlighting:
.\Run-M&A-Audit.ps1 -CompanyName "Contoso" -OutputFolder "C:\Audits\Contoso"File paths use backticks: C:\Audits\Output\
Parameters are shown in bold: -CompanyName
| Version | Date | Changes |
|---|---|---|
| 1.0 | Oct 2025 | Initial release - All 18 modules complete |
Next Steps: Choose a document from the table above based on your role and needs.