SPDocKit
Try it for FreeContact UsProduct Site
  • SPDocKit by Syskit
  • Release Notes
    • SPDocKit 12
    • SPDocKit 11.1.0
    • SPDocKit 11
    • SPDocKit 10
    • SPDocKit 9.1.0
    • SPDocKit 9
    • SPDocKit 8.0.3
    • SPDocKit 8
  • Requirements
    • SharePoint On-Premises User Permissions Requirements
    • Supported SharePoint Editions
    • System Requirements
    • Server Load Permission Requirements
    • Service Application Permission Requirements
  • Installation
    • Install SPDocKit
    • Upgrade to the Latest Version
    • Uninstall SPDocKit
  • Activation
    • Activate SPDocKit
    • Manage License
    • Activation Privacy Statement
  • Configuration
    • Configure SPDocKit
    • Configure SPDocKit Database
    • Import and Export SPDocKit Settings
  • Create SharePoint Farm Snapshots
    • Snapshots Screen
    • Manual Snapshots
    • Automatic Snapshots
  • Explore Reports & Create Documentation
    • Farm Explorer
      • Farm Explorer Screen
      • Farm Dashboard
      • Farm Explorer Reports
      • Farm Documentation
      • Passwords and Product keys
      • Generate an AutoSPInstaller XML Configuration File
      • Change the Limit on Site Topology Report
    • Site Explorer
      • Site Explorer Screen
    • Permission Reports
      • Permissions Reports screen
    • Analytics and Usage Reports
      • Analytics and Usage Reports Screen
      • Analytics Dashboard
      • Site Collection Analytics
      • Document Extensions Reports
    • Audit Reports
      • Audit Reports Screen
      • Audit Dashboard
      • Audit Log Details
      • Administrative Actions
      • Audit Settings
    • Best Practices
      • Best Practices Screen
      • Best Practices Reports
    • Subscriptions and Alerts
      • Subscriptions and Alerts
      • Create New Subscription
      • Create New Alert
    • Customizing Reports
      • Customize View
      • Add Comments
  • Compare SharePoint Configurations
    • Compare Wizard
    • Compare SharePoint Farms
    • Compare Servers
    • Compare Web Applications
    • Compare Site Collections
    • Compare SharePoint Permissions
    • Compare Web.Config Files
  • Manage SharePoint Permissions
    • Permissions Explorer Screen
    • Manage Permissions Ribbon Actions
    • Users and Groups Actions
      • Manage Groups Wizard
      • Group Memberships Wizard
      • Copy Permissions Wizard
      • Move Permissions Wizard
      • Manage Permissions Wizard
      • Remove Permissions Wizard
    • Securable Objects Actions
      • Break/Restore Permission Inheritance Wizard
      • Restore Permissions
      • Copy Object Permissions Wizard
    • Site Collection Actions
      • Site Collection Administrators Wizard
      • Permission Levels Wizard
      • Clean Site Collections Wizard
    • Add Tags
    • SPDocKit Permission Management Event Log
  • Configure & Extend SPDocKit
    • Backstage Screen
    • Options Wizard
    • License Management
    • Role Based Security
    • Extend SPDocKit
      • Install SPDocKit Extensions
      • Download SPDocKit Extensions
      • Activate SPCAF Extension
  • Query & Change SharePoint Settings
    • Queries and Rules Screen
    • Create SharePoint Governance Policy Rule
    • Create SPDocKit Query
    • Change SPDocKit Query Results Limit
    • Create Audit Queries and Rules
  • FAQ
    • Requirements
    • Installation
    • Activation
    • Configuration
    • Features
    • Security
    • Miscellaneous
    • SPDocKit Insights Removed
    • SPDocKit Insights Migration
  • Known Issues
    • CREATE TABLE permissions denied
    • Custom features missing in reports
    • Data retention not working properly
    • Distributed Cache loading issue
    • Load crashes with NullReference exception
    • Available Windows updates
    • Permissions Wizard issue
    • PowerPivot FileNotFoundException issue
    • SQL Clusters support
    • Storage Metrics report subscription
    • Unaccounted differences in the UPA settings
    • Custom Query issue with URL export
    • Recursive groups issue with export
  • Troubleshooting
    • SharePoint
      • Could not access content database
      • The service application ‘UPA Name’ does not have any proxies that are default in a proxy group
    • Server Load & User Permissions
      • RPC Server is Unavailable
      • Error occurred while loading Web Application
      • Error occurred while trying to load 'Problems and Solutions' and 'Rule Definitions'
      • Error while loading IIS Settings Information
      • Errors while trying to load the SharePoint farm
      • Errors while loading server information
      • Failed at retrieving SQL Accounts from the following servers
      • My permissions loading status is reported as ”Failed”
      • Service was unable to read Active Directory properties
      • SQL Server is unavailable
      • Error adding service account to "spdockit_service_role" database role
    • SQL Server Connection
      • SPDocKit won’t connect to a provided server and database
      • Configure SQL server to listen on a specific port
      • Is SQL Server configured to use a named instance
      • Inbound traffic on TCP Port 1433 needs to be allowed on the SQL
      • Service user does not have rights to connect to the SQL server
      • TCP/IP network traffic not enabled on the SQL Server
Powered by GitBook
On this page
  • Generate Documentation
  • Customize Documentation Template
  • Quick guide
  • Customizing styles
  • Customizing Table Styles

Was this helpful?

  1. Explore Reports & Create Documentation
  2. Farm Explorer

Farm Documentation

This article describes how to produce SharePoint farm documentation using SPDocKit.

PreviousFarm Explorer ReportsNextPasswords and Product keys

Last updated 11 months ago

Was this helpful?

Generate Documentation

This section describes how you can generate SharePoint farm documentation using SPDocKit.

  1. Use the Take Snapshot button to load local SharePoint farm settings, or choose to Open existing farm snapshot. You can view all of your snapshots if you navigate to the Backstage Actions Screen and click the View Snapshots button or if you go directly to the Snapshots tab.

  2. Click Generate from the left-side navigation pane and select the format in which you wish to create your farm documentation. The available formats are .doc, .pdf and .xlsx.

  3. The farm settings you want to export can be selected from the drop-down options.

    In the Generate Documentation window, you will be able to select which farm settings reports you wish to include in your Farm Documentation by checking the boxes in the drop-down menu. This selection you make can be saved and used as a template for generating documentation in the future. SPDocKit also comes with a set of predefined documentation templates, with commonly used options already pre-selected. The documentation templates by default are: All, Full Documentation (without Site Explorer), Regular Documentation and Simple Documentation.

    There is a possibility that there will be a large amount of data contained in Site Explorer reports, so we added a template called Full Documentation without Site Explorer. If you want to export all Site Explorer information, please note that the active snapshot will need to be saved in the SPDocKit database.

  4. The Document Outline tab displays how the table of contents of your document will look.

  5. With the Options tab you can choose whether will be displayed in the generated document. If these were not defined, the check box will be disabled.

  6. Click the Generate button, wait a few moments and your SharePoint farm documentation will be generated!

Customize Documentation Template

Quick guide

To prepare a template for your documentation, you need to prepare a Word document template and customize Word styles. SPDocKit uses Word styles to generate customized output to match your corporate branding.

  1. Create a custom Word document template (.dotx). You can also use an existing template instead of starting from scratch.

    We recommend you use the Medium Shading 1 – Accent 1 table style with this template. Customize the following styles to match your corporate branding: Heading1, Heading2, Heading3, Heading4, Normal, and Hyperlink (you can make any changes required as long as these changes are performed over the style itself).

  2. Customize the table styles to match your branding.

  3. Customize headers and footers to add your company name, page numbers, etc.

  4. Customize the front page.

  5. Remove extra content except for the custom front page (or first few pages) that you wish to be included in every document.

  6. Start SPDocKit.

  7. In the Home ribbon, click Change Styles.

  8. Select Upload a Custom Template. Click Next to continue.

  9. Browse your Word template (.dotx) and choose the table style you want to use when generating tables (we recommend you use Medium Shading 1 – Accent 1 with ).

  10. Click Finish to save.

Customizing styles

SPDocKit uses the following default Word styles to generate documentation:

  • Heading1, Heading2, Heading3 and Heading4 – used to generate section headings.

  • Normal – used to generate paragraph text.

  • Hyperlink – used for hyperlinks.

SPDocKit styles need to be customized to match your corporate or other desired branding. To modify a Style in Microsoft Word do the following:

  1. From the Styles ribbon right-click the style you want to customize.

  2. From the context menu choose Modify.

  3. A new dialog will open. Use it to make the desired changes (font, size, etc.)

Customizing Table Styles

To brand tables used in SharePoint farm documentation, you need to customize one of the built-in table styles. We currently support these styles:

  • Table Grid

  • Light Shading

  • Light Shading – Accent 1

  • Light Shading – Accent 3

  • Light Shading – Accent 4

  • Light Shading – Accent 5

  • Medium Shading 1 – Accent 1

  • Medium Shading 1 – Accent 4

  • Medium Shading 1 – Accent 5

  • Light Grid – Accent 6

  • Medium Grid 1 – Accent 4

  • Medium Grid 1 – Accent 5

  • Medium List 2 – Accent 1

  • Medium Grid 2 – Accent 2

  • Medium Grid 2 – Accent 3

To customize the table style do the following:

  1. Insert a table into the template document. (the table will be removed in the last step)

  2. From the Table Tools contextual ribbon, expand Table Styles.

  3. Right-click the style you want to change and choose Modify Table Style.

  4. Make the changes to the table style to match your desired branding. Pay special attention to the formatting of the whole table, header row, odd and even banded rows.

  5. Remove the table you inserted in step 1.

You can read more about

Passwords and Product Keys
our template
style basics in Word here.