The title of the document I leave with my clients is "Technical Architecture, Design, and Procedures Document" (TADPD). It's a rather lengthy title, but I feel is fully describes what is contained therein. The document contains details on the portal's architecture, design details on the various components/features of the portal, and procedures on how to maintain and govern the portal after I have left the client. Here are those sections broken down into what I see as the five major categories:
This section details all the physical and virtual server requirements for the portal, as well as how those requirements were decided upon. Additionally, the Authentication strategy for how users authenticate to the portal is also discussed.
Subsections:
The design portion of the TADPD goes through all the major functionalities of the portal and documents their technical implementation at a high level. The purpose for this section is to document the implementation strategy, not necessarily the implementation details. Any further documentation will be supplemented as needed in a separate document for the particular feature.
Subsections:
Environment Governance and Implementation Strategies.
The governance and implementation section is geared to help the company with the ongoing maintenance of the portal, as well as to document how to ramp up or transition new development and administration resources to the portal. Both environment caveats and instructions for how to work with the codebases will also be detailed in this section.
Subsections:
Documenting the installation and configuration is necessary to enable the successful transition of SharePoint expertise to the client for the sake of their ongoing administration. Either from a disaster recovery perspective, or if the client ever needs to add/edit a SharePoint farm, this section will provide guidance for these SharePoint administration tasks.
Subsections:
The disaster recovery section details the steps necessary to recover all the client's portals if a disaster ever were to occur. Additionally, the section documents what sorts of entities need to be backed up on a regular basis to ensure a successful restore will be possible.
Subsections:
- Architecture Planning.
This section details all the physical and virtual server requirements for the portal, as well as how those requirements were decided upon. Additionally, the Authentication strategy for how users authenticate to the portal is also discussed.
Subsections:
- Capacity Planning
- Physical Architecture
- Virtual Architecture (if used)
- Network Architecture
- Software Strategy
- Authentication Strategy
- Service Accounts
- Feature Technical Design.
The design portion of the TADPD goes through all the major functionalities of the portal and documents their technical implementation at a high level. The purpose for this section is to document the implementation strategy, not necessarily the implementation details. Any further documentation will be supplemented as needed in a separate document for the particular feature.
Subsections:
- Overview (Application diagrams)
- Branding and Look & Feel
- Portal Site Topology Design
- Feature "A"
- Feature "B"
- Search and Indexing
- Authorization Strategy
Environment Governance and Implementation Strategies.
The governance and implementation section is geared to help the company with the ongoing maintenance of the portal, as well as to document how to ramp up or transition new development and administration resources to the portal. Both environment caveats and instructions for how to work with the codebases will also be detailed in this section.
Subsections:
- Environment Governance Strategy
- Content Governance Strategy
- Security Governance Strategy
- Code & Customizations, Development Strategy
- Installation and Configuration.
Documenting the installation and configuration is necessary to enable the successful transition of SharePoint expertise to the client for the sake of their ongoing administration. Either from a disaster recovery perspective, or if the client ever needs to add/edit a SharePoint farm, this section will provide guidance for these SharePoint administration tasks.
Subsections:
- Server Preparations
- Installing SharePoint
- Configuring SharePoint and Building a Farm
- Installing dependant software (Project Server, Search Server, etc)
- Deploying Customizations & Codebases
- Disaster Recovery Strategy.
The disaster recovery section details the steps necessary to recover all the client's portals if a disaster ever were to occur. Additionally, the section documents what sorts of entities need to be backed up on a regular basis to ensure a successful restore will be possible.
Subsections:
- Backup Procedures
- Restore Procedures
Comments
Post a Comment