SPDocKit Consultant
Try it for FreeContact UsProduct Site
  • SPDocKit Consultant by Syskit
  • Product Updates
    • SPDocKit Consultant 12
    • SPDocKit Consultant 11.1.0
    • SPDocKit Consultant 11
    • SPDocKit Consultant 10
    • SPDocKit Consultant 9.1.0
    • SPDocKit Consultant 9
    • SPDocKit Consultant 8.0.3
    • SPDocKit Consultant 8
  • Requirements
    • SharePoint On-Premises User Permissions Requirements
    • Supported SharePoint Editions
    • System Requirements
    • Server Load Permission Requirements
    • Service Application Permission Requirements
  • Installation
    • Installation Guide
    • Upgrade to the Latest Version
    • Uninstallation Guide
    • PowerShell Guide
  • Activation
    • Activation Privacy Statement
    • Online Activation
    • Offline Activation
    • Manage License
    • Activation FAQ
    • Consultant License FAQ
  • Get To Know SPDocKit Consultant
    • Backstage Screen
      • Options Wizard
      • Compare Wizard
    • Farm Explorer Screen
      • Farm Dashboard
      • Farm Explorer Reports
      • Passwords and Product keys
    • Best Practices Screen
    • Snapshots Screen
    • PowerShell Commands
  • How To
    • Create Snapshot
    • Farm Documentation
      • Create Farm Documentation
      • Customize Documentation Template
    • Compare Wizard
      • Compare Farms
      • Compare Servers
      • Compare Web Applications
      • Compare Site Collections
      • Compare Web.Config Files
    • Best Practices
      • Available Best Practices Reports
      • Create Custom Best Practices Reports
      • Personalize Best Practices Reports
    • Generate an AutoSPInstaller XML Configuration File
  • FAQ
    • Miscellaneous
    • Security
    • Troubleshooting
      • RPC Server is Unavailable
      • Could not access content database
      • 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
      • The service application 'UPA Name' does not have any proxies that are default in a proxy group
      • SQL Server is unavailable
  • Known Issues
    • CREATE TABLE permissions denied
    • Distributed Cache loading issue
    • Load crashes with NullReference exception
    • Available Windows updates
    • PowerPivot FileNotFoundException issue
    • Unaccounted differences in the UPA settings
Powered by GitBook
On this page

Was this helpful?

  1. How To
  2. Farm Documentation

Create Farm Documentation

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

PreviousFarm DocumentationNextCustomize Documentation Template

Last updated 2 years ago

Was this helpful?

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

  1. Navigate to the Backstage Actions Screen and click the View Snapshots button to view all of your snapshots. Double click the snapshot to open it and navigate to the . If you navigate to the Farm Explorer without opening a snapshot the newest snapshot will be opened automatically.

  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.

    The selection you make can be saved and used as a template for generating documentation in the future. SPDocKit Consultant comes with predefined documentation templates, with commonly used options already pre-selected.

    The documentation templates available by default are: All, Regular Documentation or Simple Documentation. Use the Up and Down arrows to rearrange the order of your documentation.

  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!

Farm Explorer
Passwords and Product Keys