Answer first: Start here to install, run your first audit, and explore results. For contribution and architecture details, see development docs. For what changed, see release notes.
- 🚀 Install: guides/INSTALLATION.md
- ⚡ Quick start: guides/QUICK_START.md
- 🧭 User guide: guides/USER_GUIDE.md
- 🧩 Module reference: ../docs/MODULE_REFERENCE.md
- 📦 Scripts overview: ../scripts/README.md
- 📝 Release notes: release-notes/CHANGELOG.md
Writing style: All docs follow the Minto Pyramid Principle—answer first, then 3 key points, then supporting detail. See the STYLE_GUIDE.
Guides (install, operate, troubleshoot)
- INSTALLATION – guides/INSTALLATION.md
- QUICK START – guides/QUICK_START.md
- USER GUIDE – guides/USER_GUIDE.md
- AD DS AUDITING – guides/ADDS_AUDITING_GUIDE.md
- AD FS SECURITY AUDIT – guides/ADFS_SECURITY_AUDIT_GUIDE.md
- SMB SECURITY – guides/SMB_SECURITY_AUDIT_GUIDE.md
- EVENT MONITORING – guides/EVENT_MONITORING_GUIDE.md
- REMEDIATION – guides/REMEDIATION_GUIDE.md
- ANALYTICS & REPORTING – guides/ANALYTICS_GUIDE.md
- TROUBLESHOOTING – guides/TROUBLESHOOTING.md
Development (architecture, contribution, design)
- CONTRIBUTING – development/CONTRIBUTING.md
- DESIGN DOCUMENT – development/DESIGN_DOCUMENT.md
- DEVELOPMENT PROGRESS – development/DEVELOPMENT_PROGRESS.md
- IMPLEMENTATION COMPLETE – development/IMPLEMENTATION_COMPLETE.md
- QUERY BUILDER DESIGN – development/QUERY_BUILDER_DESIGN.md
- QUERY BUILDER ENHANCEMENTS – development/QUERY_BUILDER_ENHANCEMENTS_v2.2.md
- TEST IMPROVEMENTS – development/TEST_IMPROVEMENTS_SUMMARY.md
- GITHUB READY – development/GITHUB_READY.md
- ISSUE TEMPLATE – development/ISSUE_TEMPLATE.md
Release notes & history
- CHANGELOG – release-notes/CHANGELOG.md
- RELEASE NOTES v2.0.0 – release-notes/RELEASE_NOTES_v2.0.0.md
- POC COMPLETE – release-notes/PROOF_OF_CONCEPT_COMPLETE.md
- SQLITE POC SUMMARY – release-notes/SQLITE_POC_SUMMARY.md
Core technical docs
- FRAMEWORK SUMMARY – AD_AUDIT_FRAMEWORK_SUMMARY.md
- PERFORMANCE TUNING – AD_PERFORMANCE_TUNING_GUIDE.md
- SECURITY COMPONENTS – AD_SECURITY_COMPONENTS.md
- ENTERPRISE FEATURES – ENTERPRISE_FEATURES.md
- INCIDENT RESPONSE – INCIDENT_RESPONSE_INTEGRATION.md
- MSFT AD SECURITY GAPS – MICROSOFT_AD_SECURITY_GAPS.md
- SECURITY IMPLEMENTATION – MICROSOFT_AD_SECURITY_IMPLEMENTATION.md
- MODULE REFERENCE – MODULE_REFERENCE.md
- POWERSHELL GALLERY – POWERSHELL_GALLERY_GUIDE.md
- QUERY BUILDER – QUERY_BUILDER_README.md
- QUERY BUILDER WEB – QUERY_BUILDER_WEB_GUIDE.md
- QUERY BUILDER WEB OPTION – QUERY_BUILDER_WEB_OPTION.md
- SECURITY – SECURITY.md
- SQLITE POC GUIDE – SQLITE_POC_GUIDE.md
- SQLITE SETUP – SQLITE_SETUP.md
- Install the tool: guides/INSTALLATION.md
- Run your first audit: guides/QUICK_START.md
- Explore results: guides/USER_GUIDE.md
See development/CONTRIBUTING.md. All documentation should follow the Minto style guide.
See the release-notes for a complete change history.