SPDocGen - SharePoint Documentation Generator

Updated Wiki: Home

SharePointSezai — Thu, 03 Sep 2009 15:49:16 GMT

Servers in the farm
- Server Services
Databases
- Database Name, Server and Disk Size Required for Backup
Farm Services
- Service Job Definitions for each Farm Service
- Service Job Definition Name, Schedule, Last Time Run
Web Applications
- Name, ID, Site Collections, Content Databases and Application Pools
Site Collections
- Title, URL, Web Application, Web Count, Users Count, Disk Space Used, Owners and Site Collection Administrators
Farm Application Pools
- Name, Identity and Password
Farm Solutions
- Name, ID, Deployment Status, Last Deployment Action Time, Last Operation Details, Deployed Servers, Deployed Web Applications
Farm Feature Definitions
- Feature Name, ID, Scope, Root Directory, Solution ID, Receiver Assembly and Class

If the executable throws an error, copy out the exception message and post it to the Issue Tracker for this project.

If you hit any exceptions or issues, or have any suggestions for improving this tool please add them to the Issue Tracker for this project, or alternatively post a comment here : http://sharepoint-sezai-moss-2007.blogspot.com/2009/08/spdocgen-sharepoint-documentation.html

Updated Wiki: Home

SharePointSezai — Thu, 03 Sep 2009 15:47:04 GMT

Project Description
Automatically generate SharePoint Farm Documentation in a few seconds.

The application uses the SharePoint Object Model API to produce an XML file containing data from a SharePoint Farm Deployment. The XML file is then transformed into a .doc file (WordML) via XSLT.

1. Unzip to a folder on a WSS 3.0 or MOSS 2007 server.

2. Logon to the server as a Farm Administrator with permissions
to write to the folder that Sezai.SPDocGen.Console.exe runs from.

3. Produces an XML and DOC file as output, modify the XSLT file as you like.

Full Source Code for the solution is provided so you can tweak it as needed.

What does this tool document?

Servers in the farm
Server Services
Databases
Database Name, Server and Disk Size Required for Backup
Farm Services
Service Job Definitions for each Farm Service
Service Job Definition Name, Schedule, Last Time Run
Web Applications
Name, ID, Site Collections, Content Databases and Application Pools
Site Collections
Title, URL, Web Application, Web Count, Users Count, Disk Space Used, Owners and Site Collection Administrators
Farm Application Pools
Name, Identity and Password
Farm Solutions
Name, ID, Deployment Status, Last Deployment Action Time, Last Operation Details, Deployed Servers, Deployed Web Applications
Farm Feature Definitions
Feature Name, ID, Scope, Root Directory, Solution ID, Receiver Assembly and Class

If the executable throws an error, copy out the exception message and post it to the Issue Tracker for this project.

If you hit any exceptions or issues, or have any suggestions for improving this tool please add them to the Issue Tracker for this project, or alternatively post a comment here : http://sharepoint-sezai-moss-2007.blogspot.com/2009/08/spdocgen-sharepoint-documentation.html

Updated Wiki: Home

SharePointSezai — Thu, 03 Sep 2009 14:30:43 GMT

Updated Release: SPDocGen 0.2 (Aug 31, 2009)

sharepointsezai — Thu, 03 Sep 2009 14:29:07 GMT

1. Unzip Sezai.SPDocGen.zip to a folder on a WSS 3.0 or MOSS 2007 server.

2. Logon to the server as a Farm Administrator with permissions
to write to the folder that Sezai.SPDocGen.Console.exe runs from.

3. Produces an XML and DOC file as output. Modify the XSLT file to change the output as you like.

Sezai.SPDocGen.SourceCode.zip contains the full source code.

Released: SPDocGen 0.2 (Aug 31, 2009)

Thu, 03 Sep 2009 14:29:07 GMT

Updated Release: SPDocGen 0.2 (Aug 31, 2009)

sharepointsezai — Thu, 03 Sep 2009 14:25:41 GMT

Initial Release contains

console application Sezai.SPDocGen.Console.exe
class library Sezai.SPDocGen.dll
WordML XSLT file DocGen.xslt

Updated Wiki: Home

SharePointSezai — Wed, 02 Sep 2009 06:21:30 GMT

--------------
Extract the 3 files into a folder on a SharePoint Server in your farm and run the executable
Ensure the account you are logged in with has Farm Administrator priveleges and can write to the folder in which you run the executable.

If the executable throws an error, run it in a command window and copy out the exception message and post it to the Issue Tracker for this project.
If you hit any exceptions or issues, or have any suggestions for improving this tool please add them to the Issue Tracker for this project, or alternatively post a comment here : http://sharepoint-sezai-moss-2007.blogspot.com/2009/08/spdocgen-sharepoint-documentation.html

Updated Release: SPDocGen 0.1 (Aug 31, 2009)

sharepointsezai — Mon, 31 Aug 2009 16:50:12 GMT

Initial Release contains

console application Sezai.SPDocGen.Console.exe
class library Sezai.SPDocGen.dll
WordML XSLT file DocGen.xslt

Feel free to modify DocGen.xslt as you like.

I eventually plan to release the source for the class library after some refactoring and cleanup, I also hope to expand on this so it can document info on site collections, sites and lists.

Released: SPDocGen 0.1 (Aug 31, 2009)

Mon, 31 Aug 2009 16:50:12 GMT

Updated Release: SPDocGen 0.1 (Aug 31, 2009)

sharepointsezai — Mon, 31 Aug 2009 16:46:20 GMT

Updated Release: SPDocGen 0.1 (Aug 31, 2009)

sharepointsezai — Mon, 31 Aug 2009 16:44:45 GMT

Initial Release containing console application Sezai.SPDocGen.Console.exe class library Sezai.SPDocGen.dll and WordML XSLT file DocGen.xslt

Feel free to modify DocGen.xslt as you like.

I eventually plan to release the source for the class library, and hope to expand on this so it also documents further detailed info around site collections, sites and lists.

Created Release: SPDocGen 0.1 (Aug 31, 2009)

sharepointsezai — Mon, 31 Aug 2009 16:42:07 GMT

Initial Release