FAQ
-
What is As Built Report?
As Built Report is an open source configuration document framework which utilises Microsoft PowerShell to produce as-built documentation in multiple document formats for multiple vendors and technologies.
The framework allows users to easily generate clear and consistent documentation, for any environment which supports Microsoft PowerShell and/or a RESTful API.
-
What versions of PowerShell are supported?
As Built Report will generally support both Windows PowerShell 5.1 and PowerShell 7, however each individual report will have its own system requirements.
Please refer to the report module user guides for PowerShell compatibility and system requirements.
-
What is PScribo?
PScribo (pronounced 'skree-bo') is an open-source project created by Iain Brighton.
PScribo provides a set of functions that make it easy to create a document-like structure within Powershell, without having to handle multiple output formats. A document's layout and contents only need to defined once regardless of target output format(s).
-
What document formats are supported?
DOCX (MS Word), HTML & Text are all supported document formats.
-
Do I need Microsoft Word installed to generate a report in DOCX format?
No. Microsoft Word is not required to generate the report, however a document viewer which supports the DOCX format would be required to view the report.
-
How do I install As Built Report if I do not have access to PowerShell Gallery?
Please refer to the installation page for instructions on how to perform an offline installation of As Built Report.
-
How can I contribute to the project?
Please refer to the contributing page for information on how to contribute to this project.
-
How can I donate to the project?
Please refer to the donate page if you would like to offer your support for this project.
-
How can I provide feedback or ask for further assistance?
You may provide feedback or ask for assistance via our contact page.