Ви переглядаєте довідкову інформацію для версії:

This glossary lists (alpabetically) details of all Deliverable documents from the Project Checklist.

Acceptance from Business Stakeholders

Acceptance from business stakeholders confirms that they, as key stakeholders, are aligned with the solution and have given their approval as to how the business requirements meet the business case.

Acceptance Tests

Acceptance testing is performed when an application is ready for production. The tests are performed by a group representing the various types of end-user, using real-life scenarios. 

Acceptance tests are used to confirm that the:

  • Project fulfills the customer's requirements.
  • Solution is fit-for-purpose.
  • Users accept the solution and can envisage working with it.
  • Customer accepts the project.

The earlier you plan and design your acceptance tests, the easier the final deployment will be. They should be defined together with the customer and your Quality Assurance team.

Although you might not be able to define all details at the very start of the project, initial definitions should be discussed and agreed on. The acceptance tests will probably be based on the fundamental requirements (functional and performance).

Access to Test System Coordinated

Ensure that the required levels of system access have been granted to all roles.

Adobe Security Checklist

The Adobe Security Checklist is the official checklist provided to ensure that AEM is secure at installation. It contains the security measures and verification steps you need to perform to ensure the integrity of your instance.

Adobe Support Portal Project Set Up

The Adobe Support Portal enables implementation partners and customers to set up the AEM implementation as a project in the Support Portal.

Details can be registered; for example, about the technologies and versions implemented. These provide transparency between the customer and Adobe.

AEM Administrator Training

Training for administrative staff of the solution. See the Adobe Training Services for more information.

AEM Author Training

Training for staff who will be producing (authoring) content for the solution. See the Adobe Training Services for more information.

AEM Certification Exam

Ensure that the appropriate persona are registered to take the relevant certification exams.

AEM Certified

Ensure that the appropriate persona have passed the relevant certification exams.

AEM Technical Training

Provide technical training for the appropriate persona; for example, developers, architects, engineers and business practitioners.

Agreement on KPIs Defined as Goals for the Project

Key Performance Indicators (KPIs) help an organization to define and measure progress toward organizational goals and objectives. Once an organization has analysed its mission and defined its goals, it needs to measure progress towards those goals. KPIs provide a mechanism for measurement. 

Align Business and Performance KPIs

Alignment of your business and performance Key Performance Indicators (KPIs) helps pull together all the involved people and processes from within the organization. This in turn helps reduce the amount of time and effort required to achieve business goals and fulfill the proposed purpose.

Alignment of Content Architecture with KPIs

Ensure that the proposed content architecture is aligned with the relevant Key Performance Indicators (KPIs).

Alignment of the Customer Roadmap with Project Timeline

The Customer Roadmap is comprised of high level milestones and business goals. The Project Timeline must adhere to and align with this strategy, so any potential risks and/or possible deviations must be highlighted and tracked.

Application Architecture Definition

The application architecture should clearly define the behavior of the proposed applications.

It is focused on:

  • How they will interact with each other and with users. 
  • The data to be consumed and produced by applications, rather than their internal structure.

Application Specific Maintenance Tasks Defined

Apart from standard Adobe Experience Manager (AEM) maintenance tasks, you need to define any other operational tasks that need to be executed for the ongoing maintenance of the solution.

Appropriately Trained Staff

Ensure that your team is made up of staff with the appropriate training. For project teams the recommendation is to have all of the following:

  • at least one AEM certified Lead Developer 
  • at least one AEM certified Architect 
  • at least 75% of your developers AEM certified;
    this allows the certified developers to mentor junior developers and ensures knowledge sharing and transparency

Architecture Diagram

The architecture diagram is a graphical representation of the architecture. It includes representation of:

  • the concepts
  • their principles
  • elements and components that are part of the architecture

Architecture Draft

This provides a high level view of the system and solution architecture. At this stage it is a draft that will be reviewed and refined at later stages.

Architecture Review Board Sign Off

The Architecture Review Board is a cross-organizational body that:

  • oversees the implementation of a coherent strategy 
  • ensures compliance in systems

The review board should be representative of all key stakeholders involved with the architecture. Typically they will comprise of a group of executives responsible for the review and maintenance of the overall architecture.

Automated Test Suite Adapted for Real Content and Results Compared to KPIs

Automation scripts and basic automated use cases:

  • adapted for production content
  • checked against the KPIs

Automated Testing Strategy

This strategy defines a framework for reusable automated scripts, together with the approach planned by the Quality Assurance (QA) team. It outlines the overall plan for automation testing to help ensure:

  • a higher Return on Investment (ROI)
  • more test coverage
  • increased test reliability with quality repetition

Automated Testing Strategy Validated Against Realistic and Expected Load

The Automated Testing Strategy must be validated and adjusted according to the content and expected load that will be on the solution. 

Automation Strategy

The automation of deployments ensures faster and consisent deployments. The Automation Strategy outlines the configuration of any such automation mechanisms; including:

  • frequency
  • tooling to be used
  • environments to be deployed to

Aware of Communication Plan

The entire project team and all stakeholders must confirm that they are aware of the:

  • reporting structure
  • cadence of reporting
  • channels of communication

Aware of Success Definitions and Criteria

The entire project team and all stakeholders must confirm that they are aware of the:

  • definitions of success
  • criteria for success

Backup and Restore Concept

The Backup and Restore Concept outlines the technical functionality that will be implemented in the solution.  It is required by the Company back up and restore policy.

Backup and Restore Tested

A full end-to-end test based on the Backup and Restore Concept.

Business Case(s)

A business case document presents the arguments related to taking the action, taking alternative action (if available), or not taking any action. The arguments should be balanced, based on concrete facts (wherever possible/relevant) and highlight both the benefits and risks for all cases.

A business case document should be a clear definition of all options, concluding with a compelling argument for implementation of the proposed solution. 

Business Analyst Understands Scope of Project and Expectations

The Business Analyst should confirm that they fully understand:

  • the scope of the project
  • all customer expectations
  • that this is the basis for all decisions made per persona, per phase in the project

Business KPIs

Organizations use Key Performance Indicators (KPIs) to evaluate their success at reaching targets.

Business KPIs define measurable values that demonstrate how effectively a company is achieving key business objectives. It is important to choose KPIs appropriate to your business/scenario with clear definitions of what they are, how they will be measured, how they will be used and by whom.

Business Requirements Documentation

A business requirements document (BRD) details the business solution for a project, providing a clear specification of the customer's business needs and expectations. The BRD also distinguishes between the business solution and the technical solution.

When examining the business solution the BRD should answer the question:
    “What does the business want to do?” 

Business Sign Off on any Required Adjustments to the Solution or Architecture Identified and Aligned Against ROI and KPI Expectations

The processes of risk assessment and penetration testing may produce issues and outcomes that need to be addressed in the architecture or development of the solution.

Any adjustments resulting from these processes need to be reviewed and approved by the business and gauged against the overall goals.

Caching Strategy

The Caching Strategy outlines what will be cached for the end user. It must be compliant with the Performance KPIs.

For examples, elements such as images, javascript and other server files can be cached to improve the performance of a solution.

Coding Guidelines

The Coding Guidelines define basic principles that the developers should adhere to when developing the solution. These can include, amongst others:

  • naming conventions
  • service usage
  • library usage

Communicate Operations Manual

Ensure that all appropriate persona/roles have received the Operations Manual.

Communicate Performance Test Report

Ensure that all appropriate persona/roles have received the Performance Test Report.

Communicate Release Notes

Ensure that all appropriate persona/roles have received the Release Notes.

Communicate Scope and Expectations to Team

Ensure that the project team is fully aware of, and aligned with, the project scope and expectations for delivery.

Communicate Training Materials and User Guides

Ensure that all appropriate persona/roles receive the training materials and user guides.

Compliance with Customer Security Requirements

Ensure that all the customer's security requirements are in place.

Compliance with Security Concept

Ensure that the Security Concept is in place.

Components and Templates Relationship Concept

The outline of the templates and components that will be used in the new application. Includes details such as inheritance rules, permissions and relationships, amongst others.

Components and Templates Relationship Specification

Details of the components and templates relationship concept.

Components Specification

Specification details for each of the components to be implemented.

Concept for Mock-ups of External Interfaces

The concept of how to develop against and test any external interfaces that may not be open/available to the development or test environments.

Plan/implement mock-ups of these interfaces to ensure testing is as close to production-like behavior as possible.

Content Architecture Document

Documentation of the proposed architecture of the content. The details should include, (amongst others):

  • content tree
  • tagging concepts
  • strategies for the reuse of content

Content Validated for Migration

The legacy system content is reviewed and the selected content is validated for migration to the new solution.

Contract Draft

An initial draft of the legal contract.

Current Content Structure and Format

Documentation of the current content architecture and format. This will be used to generate the future content architecture. It will also be used for the Migration Concept.

Customer Backup and Restore Policy

Policies from the customer concerning:

  • backup processes for both data and the solution
  • storage of the backup
  • confirmation that the backup is operating as expected
  • restoration, in case of failure

Customer Coding Guidelines

Any guidelines/requirements from the customer on how development should be done.

Customer Deployment/Release Policies

Policies from the customer that define how and when deployments/releases can be made.

These often include timelines, scheduling and sign-off requirements.

Customer Monitoring Policies or Requirements

Customer policies and requirements on what should be monitored. These are in addition to any recommendations specified in the Monitoring Concept.

Customer Production Release Schedule

The schedule that is defined by the customer for releases to the production environments.

Customer Reporting Policies and Requirements

Any policies and/or requirements that the customer has in regard to reporting. These can include:

  • how often specific reports should be delivered
  • the format for specific reports
  • special requirements

Customer Roadmap

Formulate a roadmap of the major milestones to be implemented, both technological and business. This roadmap is then communicated to the customer.

Customer Security Policies

The customer (business and IT) will have policies that define the required security levels for the solution. These can include:

  • Requirements for passing a risk assessment. 
  • Requirements for passing penetration tests.
  • Any specific security requirements; such as escaping of all input fields, encryption usage (SSL), certificates, and authentication and sessioning.

Customer Specification Guidelines

Any guidelines the customer has relating to the format, delivery and sign-off of specifications.

Customer Test Reports

Reports from the customer to the Quality Lead during the User Acceptance Test (UAT) period.

Customizations and Hotfixes that Affect Upgrades Documented

Any customizations and/or applied hotfixes applied must be documented as they can affect future upgrades:

  • AEM can be heavily customized to suit business needs. Any customizations that may impact upgrading must be fully documented. For example, any major changes to the user interface (UI) of AEM. 
  • Any updates required for the current solution must be fully documented; these can include:
    • cumulative fix packs (CFP)
    • service packs (SP)
    • hotfixes
    • upgrades

Daily User Acceptance Test Report

Reports or meetings resulting from the User Acceptance Testing (UAT). They should detail:

  • the issues reported
  • prioritization of these issues

Default Security Enabled

Ensure that the default security settings for AEM have been enabled/implemented. 

Deployment/Release Policies and Processes

Formalized policies covering both the deployment and release(s) of your project. These can include:

  • time for releases
  • holiday planning
  • frequency 
  • and can depend on the environment in question

Deployment Cadence Established

Define the required frequency of deployments across environments.

Development Methodology

A software development methodology involves breaking the entire process of software development work into distinct phases (or stages), each with distinct activities. The aim is to improve planning and management. 

When defining the methodology you should pre-define specific deliverables and artifacts that are created and completed by the project team to develop or maintain your application.

Development Role Definition

Define which developer and/or role is executing IT (performance or other) and/or unit tests within the solution.

Development Environment Ready

Ensure that the development environment is configured with the integrated tooling required for the automation of deployments.

Development Team Understands Scope of Project and Expectations

The Development Team should confirm that they fully understand:

  • the scope of the project
  • all customer expectations
  • that this is the basis for all decisions made per persona, per phase in the project

Dialogs Specification

Details about the dialogs required for the solution.

Document Development Environment Setup

Documentation of the development environment.

Document Production Environment Setup

Documentation of the production environment.

Document Test Environment Setup

Documentation of the test environment.

Durability Test

The Durability Test shows the performance of the solution under a specific load. The tests gauge how long the solution survives when submitted to the threshold load and at what performance levels.

Durability Test Executed

Execution of the durability test(s).

Error Handling Concept

Error handling refers to the anticipation, detection, and resolution of programming, application, and communication errors.

Error Handling Documentation

Detailed documentation of the proposed error handling, based on the Error Handling Concept.

Escalation Processes

Definition of all escalation processes. There will be separate processes for each project level:

  • Project team
  • Customer
  • Adobe

Establish Regular Quality Review Sessions

Establish regular quality review meetings with the appropriate team members.

Existing Permissions Structure

Documentation of the existing set of permissions and groups defined for either the legacy solution or within the organization.

Existing Systems Map

A diagram (or set of diagrams) of the existing systems and dependencies.

Expected Success Definitions and Criteria

The Project Sponsor collects the business expectations related to the success of the project. It is important to have the full set of expectations available at the start of a project as these should influence all decisions made throughout the implementation.

Expections can include:

  • specific KPIs, such as the percentage increase in pages served
  • lower time for publishing content
  • higher level goals, such as an easy-to-use interface 

Experience Designs Requirements

Requirements for the entire experience of the solution. This covers factors such as personalization, cross device persistence and user experience, amongst others.

Experience Specifications

Details of the Experience Design Requirements.

External System and User Dependencies/System Context

A diagram (or set of diagrams) outlining the full ecosystem of the solution. This should include elements such as the external integrations, interfaces, dependencies and networks.

Fallback System and Procedure

The definition of the fallback system:

  • the business critical functionalities that must keep operating in the case of a critical failure
  • the processes required in the case of fallback

Fallback System and Procedure Tested

End-to-end test of the fallback system.

Fallback System Sign Off from Business Stakeholders

Sign off, from the business stakeholders, that the fallback system and related procedures will ensure the critical business functionalities.

Feasibility Confirmation on KPIs

Results of a feasibility study for both AEM and the high level solution design. These should be measured against the KPIs to ensure that these can be met.

Finalized Contract

A finalized and signed contract is needed before proceeding with the project. This is based on the Contract Draft.

Functionality of the Solution Accepted by Stakeholders

Confirmation that the stakeholders fully accept the:

  • solution functionality
  • any known issues in the solution

Go Live Schedule

Timeline and schedule for the activites required for:

  • preparation for go live
  • the actual go live

Happy Paths Defined

A happy path is a default scenario featuring no exceptional or error conditions. It is comprised of the sequence of activities executed when everything goes as expected.

Hardware Estimates

Initial estimates of:

  • the hardware needed for basic AEM installation
  • any additional requirements, based on the high level solution design

Hardware will be Available to Fulfill Requirements

Confirmation that all environments will have the minimum required hardware in place.

High Level Requirements

Definition of the high level requirements provides a generalized breakdown of requirements for the system, covering aspects such as:

  • Business processes
  • Major system functions

Basic details about these functions are usually known, so this document should not be an estimate.

High Level Solution Design

The high-level solution design explains the architecture that will be used for developing the solution. The architecture diagram provides an overview of the entire system, identifying the main components that will be developed for the product and their interfaces.

High Level System Map

This system map should provide a very high level diagram of the system. It differs from the Solution Context in that is it a generalized map of all systems involved, there are no interfaces on this diagram.

Historical Content Structure

Definition of the content structure of the legacy system. This is used for reference and also when preparing the migration strategy.

Historical Performance and Historical Performance KPIs

You need to collect and document performance statistics and performance KPIs from the legacy system. These are then used as a reference point and for benchmarking the new solution.

Identify Critical Key Solutions/Functionalities

A list of the business critical functionalities.

Implementation - Changes Based on Penetration Test Results

Implementation of all required changes (that have been signed off) to the solution based on the results of the penetration tests.

Implementation - Automated Testing Strategy

Setup of the tooling and processes required to support automated testing.

Implementation - Automation Strategy

Setup of the tooling set and processes required to support automation.

Implementation - Content Architecture

Implementation of the content architecture, tagging concepts and reuse of content.

Implementation - Experience Design

Implementation of the requirements to support the Experience Design.

Implementation - Fallback System and Procedures

Implementation of the fallback system and related procedures.

Implementation - Integration

Implementation of integrations with all required external systems.

Implementation - Migration Strategy

Migration together with the validation of content and other artefacts for the new solution.

Implementation - Roles and Rights

Implementation of roles and rights, users and groups.

Implementation - Security Concept

Implementation of all security measures, including the AEM defaults.

Implementation - Security Software

Implementation of software application security.

Implementation - System Architecture Security Concept

Implementation of the system security.

Implementation - URL Handling

Implementation of the URL handling concept.

Implementation - Workflows

Implementation of the designed workflows.

Implementation Concept

The implementation concept provides the guiding principles for the entire implementation. It should take into consideration:

  • Operations
  • Maintenance
  • Compatability
  • Reusability
  • Security
  • Scalability

This concept can also outine the frameworks, libraries and other artifacts used in the solution.

Inform Adobe Support About the Go Live Schedule

Contact Adobe Support to ensure that any support that is needed, can be enabled during the go live.

Initial Experience Designs

Preliminary concepts for the designs of the experiences.

Integration Testing

Testing, and the resulting confirmation, of all integrations, both internal and external.

This should be automated and run frequently to ensure system stability.

Issue Tracking Process

Clear processes record all issues encountered and track ongoing activities with the aim of ensuring that all issues are addressed.

Issue Tracking System and Processes

A tracking system, together with the required processes, to record all issues encountered and track ongoing activities with the aim of ensuring that all issues are addressed.

All project stakeholders should have access in order to facilitate transparency of the project status.

Examples includes Atlassian JIRA and HP Quality Center.

Issue Tracking System Process is Set Up and Integrated

The selected tooling is fully integrated and access granted to all required roles.

Legacy System

For your project the legacy system is the existing technology, computer system, or application program that will be replaced by the new solution.

Details of the legacy system should be collected so that you know what can be retired, when and the impact on any other systems.

List of Development Tools to be Used

An outline of tools that will be used in the implementation; the tools should include:

  • documentation tools
  • issue tracking tools
  • deployment tools
  • build tools

List of Users that Require Access to Adobe Support Portal

A list of all users and roles that will need access to the Adobe Support Portal.

The list is normally comprised of the Solution Architect and/or customer IT staff.

Log File Analysis

An analysis, together with the resulting recommendations, defining what needs to be logged in order to monitor the solution:

  • activities to be logged
  • level of granularity
  • information logged for each activity

Maintenance Tasks (AEM Specific) Tested and Enabled

Test and enable AEM maintenance tasks such as:

  • compaction
  • system clean
  • workflow purging

Migration Plan

Document the migration; including

  • timeline for the migration
  • content maintenance plan, according to the migration strategy

Migration Strategy

A full description of the existing content, content architecture and formats mapped to the new solution. It should cover:

  • technical details of automated migration if possible
  • smoke tests to perform after migration, to validate the migrated content

It should also recommend how to keep the content up-to-date (or as up-to-date as possible) during the period between migration and the actual go live of the new system. This could mean a content freeze, double publishing, or the maintenance of an alpha system.

Monitoring - CPU

Monitoring the solution's use of the system CPU:

  • average
  • peaks

Monitoring - Disk I/O

Monitoring the solution's disk input and output rates:

  • average
  • peaks

Monitoring - Disk Space

Monitoring the solution's use of disk space:

  • average
  • growth over time

You should monitor use by:

  • the repository
  • log files

Monitoring - External System(s)

Monitor any connections between the solution and external systems:

  • rate of traffic
  • peaks
  • stability

Monitoring - Network Bandwidth

Monitor the solution's usage of the network bandwidth:

  • average rate of traffic
  • peaks
  • stability

Monitoring - Requests

Monitor the requests made to the solution.

Monitoring - Security Points

Monitor at the defined security points.

Monitoring - System

Monitor the overall system; for example:

  • availability
  • average performance
  • performance peaks
  • alerts

Monitoring - Threshold and Intervention

Monitoring of the solution's defined threshold together with the implementation of intervention steps to reduce load.

Monitoring Concept

The monitoring concepts to be applied to your solution; incorporating:

  • AEM standard monitoring
  • system monitoring
  • customer specific monitoring requirements

Monitoring Potential Weak Points

Specific points that could be susceptible to failure, should be identified and defined. Any monitoring tasks related to these should also be defined.

Examples include (amongst others):

  • key workflows
  • transactions processing
  • integration points

Monitoring Policy Communicated to System Engineer

Ensure that the system engineers and operations staff know and understand any monitoring policies.

Monitoring Reports - Structure in Place

Define:

  • when monitoring reports should be generated 
  • who they should be delivered to

Operational Tasks Documentation

All operational tasks documented, with their frequency defined.

Operations Manual

Manual providing all the information required for the successful operations and maintenance of the solution:

  • all operational tasks
  • key contacts
  • deployment plans
  • pre-/post- deployment checklists
  • any other critical tasks

Should also detail the implementation concepts for:

  • meeting the perfornance KPIs
  • scaling the solution to continue to meet those KPIs

Package Prepared

Software package built and delivered ready for deployment.

Penetration Tests

A penetration test (informally known as a pen test) is an attack on a computer system that looks for security weaknesses, potentially gaining access to the computer's features and data.

Penetration Tests - Passed

All required criteria are passed.

Penetration Tests - Results

Reports created for the business explaining the penetration test results.

Performance and Scalability Concept

Conceptual document about how to ensure that your implementation meets the perfornance KPIs, and how to scale the solution so that it continues to meet those KPIs.

Performance Benchmark

The Performance Benchmark is used to define performance testing, durability testing and monitoring. It does this by assessing the performance characteristics of the solution and system hardware.

Performance KPIs

These define the Key Performance Indicators (KPIs) required to measure performance of the system. Some examples include page load time, server response time and database query performance.

Performance Tests - Report

Reports created for the business, detailing the results of the performance tests.

Performance Tests - Results Match Performance KPIs

The results must match the defined KPIs and expectations for performance.

Persona Based Testing Concept

Persona based testing is a method based on the different personas outlined in the Experience Designs. It also tests the accounts and their related permissions levels.

This is often used in User Acceptance Testing (UAT).

POC Tested and Verified against Requirement Documentation

The Proof of Concept (POC) is gauged against the requirements to ensure that both are aligned.

Post-Deployment Checklist

A checklist to define the series of checks and tasks to perform after each deployment.

Pre-Deployment Checklist

A checklist to define the series of checks and tasks to perform before each deployment.

Production Environment Baseline Performance Tests

It is usual to run a baseline test on a standard installation of AEM. This is then used as a benchmark to test the implementation and hardware against.

Production Environment Ready

Confirm that the production environment is ready, with automated deployments in place.

Production Sign Off from Business Stakeholders

Before Go Live onto the production environment, Production Sign off (PSO) must be granted. This is the result of a review of the release that will go into production, together with any known issues. Sign off is given as part of the Go Live schedule.

Production Sign Off Process and Policy

The policy and process required to obtain the Production Sign off before moving the package to the production environment.

Project Communication Plan

Define the communication plan for both businesss stakeholders and the project team.

Project Efforts - Final Estimates

The initial estimates were high level and made according to the high level requirements for the implementation.

These are now reviewed, refined and expanded to provide the final estimates. Estimates should be delivered by each appropriate project lead, including project management, consulting, architecture, testing and development.

These estimates are used for resourcing and budgeting.

Project Efforts - Initial Estimates

Initial estimates are high level and made according to the high level requirements for the implementation. This will be reviewed and refined at later stages.

Project Organization

The required documentation to outline the organization and reporting structure of the project and team.

Often takes the form, or includes, a chart to present a visual overview of timelines and responsibilities. There are many tools available to help with this.

Project Scope Document

The project scope document requires you to identify and document a list of:

  • Specific project goals
  • Deliverables
  • Features
  • Functions
  • Tasks
  • Deadlines
  • Planned effort

It covers what must be achieved, together with the work that must be done, to deliver the project

Project Status Reports Within a Defined Cadence

Project status reports delivered according to the agreed schedule and with the required format.

Proof of Concept (POC)

The Proof of Concept (POC) implements a limited range of functions for the solution.

It should aim to demonstrate the feasibility of the solution, verify that it can fulfil the required purpose and prove that there is the potential of it being used.

Purge Rules

AEM maintains multiple versions of assets and content. Purge rules are designed and configured to periodically remove the older versions in order to maintain repository health and size.

Quality Report Format and Cadence

Define the required content and format of the quality report, together with how frequently it must be delivered.

Release Coordinated

The project manager coordinates all roles required for the release to production.

Release Notes

Release notes are part of the documentation for the release. The release notes should cover:

  • prerequisites
  • requirements included
  • issues solved
  • known issues in the release

It is used with the Runbook to execute pre- and post installation steps and checks.

Примітка.

For an example, see the AEM Rekease Notes.

Release Running on Production Environment

Final release running and active in production.

Relevant Contract Terms

You should highlight specific contract terms that are relevant to the implementation of the project; such as contractual milestones, invoice periods or staff requirements.

Reporting Cadence

Together with the customer, define the frequency of reports delivered to them.

Repository Optimization

Data is never overwritten in a tar file, the disk usage increases even when only updating existing data.

To counteract the ever increasing size of the repository, an optimization strategy is put in place to remove obsolete data.

Request for Setting Up Project Section in Adobe Support Portal

The official request to set up your project in the Adobe Support Portal.

Requirements Documentation

This set of documentation covers the functional and non-functional requirements, together with the efforts estimated.

Resources Available to Support Go Live

Ensure that all the roles required for go live are staffed and available.

Risk Assessment

The Risk Assesment is executed by the customer's IT and/or Security department(s).

It assesses the technical and business risks of the project. The assessment is required for the solution to ensure compliance to security policies.

Risk Mitigation Plan

The Risk Mitigation Plan includes the Risk Assessment. Together they cover:

  • identified risks 
  • possible solutions to those risks should they arise in the implementation

ROI Expectations

Define the Return on Investment (ROI) expectations that are attached to the solution.

They aim to indicate the efficiency of the solution in economic terms by defining the benefits/profits expected in relation to the estimated investment.

Roles and Rights Concept

Detailed specification of the concepts relating to roles and access rights required for the new application, including a high level outline of:

  • roles
  • groups
  • users
  • permissions
  • as well as user management and provisioning

Roles and Rights Concept Meets Security Guidelines

Review of the Roles and Rights concept to ensure that it meets the security policies. 

Roles and Rights Specification

A detailed specification based on the Roles and Rights Concept.

Security Architecture Recommendations

Recommendations related to security for the software and hardware architecture.

Security Based Coding Guidelines

These guidelines define how the development coding should be done, based on security requirements such as:

  • naming conventions
  • libraries
  • guidelines for frameworks
  • API usage

Security Checklist

Project specific checklist of items, based on the Security Concept together with any additional policies required to ensure compliance of the solution.

Often this is also included as part of the post-deployment steps in the runbook.

Security Concept

Define and document details of the security configuration required for the application, architecture and infrastructure.

Security Concept Draft

A high level outline covering the security setup of the:

  • application
  • architecture
  • infrastructure

Security Issues Listed and Assessed

All security issues of the solution listed and assessed; including effort estimates.

Security Sign Off from Business Stakeholders

Sign off from the stakeholders to ensure that the security implementation is compliant with policies and expectations.

Set up Support Processes

Set the required support processes in place.

SLAs for Third Party Systems

Ensure that Service Level Agreements (SLAs) are available and communicated to both the development and operations teams for use during implementation and support.

Smoke Test Concept

Smoke tests consist of a set of defined steps that test the key functionalities of the solution to ensure basic operations and functionality of the solution.

They are executed, on any environment, after installation or deployment. 

Smoke Tests Executed for System Validation

Smoke Tests should be run on all systems to ensure correct operation of the solution's basic functionality on installation or deployment to any environment.

Software Architecture Strategy

The high level strategy for the software architecture; including services, servlets, frameworks and other implementation decisions.

Solution Review Board Established and Meeting Cadence Set

The Solution Review Board is usually comprised of customer stakeholders.

The board holds regular meetings to review the currently scoped requirements and relevant specifications on an ongoing basis. The aim is to ensure alignment with the success definition and criteria and also provide input into the development of the requirements.

Solution Runbook

Installation instructions for the solution, together with basic operational tasks to be executed on installation.

Solution Sign Off and Acceptance Process

The sign off and acceptance process outlines the criteria that must be fulfilled before the solution can be released into a productive environment.  

It can also serve as a contractual milestone.

Special Functionality Concept

The initial concept for any special functionality that is considered outside the normal scope of development on the AEM platform.

Special Functionality Specification

Details of any special functionality that is considered outside the normal scope of development on the AEM platform.

Specification Guidelines

Any guidelines from the customer on how the specification should be done.

Specification Review and Approval Process Defined and Communicated

A clear process for the customer sign off of specifications should be put in place. This process ensures clarity and firmness of scope for the requirements.

Staff Selected for AEM Administrator Training

Internal staff that will need training to administer the solution.

Staff Selected for Author and End User Training

Internal staff that will need training to author on the solution.

Stakeholders

Stakeholders are the key persons and/or roles that have a significant interest in the project. Some will be contributing towards the project budget. 

The stakeholders can be internal and/or external. 

Stakeholders are Aware of Success Definitions and Criteria

Confirmation that all stakeholders outside the actual implementation team are aware of the:

  • definitions of success
  • criteria for success

Stakeholders Understand Project and Expectations

Confirmation that all stakeholders outside the actual implementation team are in alignment with the overall project and expectations, both internal to the project team and to the customer.

Status Report Format Definition

Status reports are a key tool of communication. The format should be aligned with any reporting requirements from the customer.

Success Criteria and Definition

The customer, project sponsor and project manager or consultant should specify:

  • What defines a successful outcome for the project.
  • The specific criteria required to meet that definition of success.

These are used to ensure that the criteria for success are met:

  • As the basis for KPIs. 
  • When making decisions throughout the implementation.

Support in Validation of Reported Issues

Part of the Quality Lead's responsibilities are to ensure that there are resources available to support any user when testing. For example, to help the user when testing, when reporting issues and to help validate the issues against the test environment.

Support Processes and Access to Adobe Support Portal

Access to the Adobe Support Portal is crucial for submitting tickets about any product based issues that may arise during implementation. 

Access should be allocated to key members of the team.

System Architecture Definition

An initial proposal and definition of the architecture for all environments of the solution.

System Architecture Documentation

A document detailing the system architecture; including interfaces, network location and integrations for all environments, amongst other information.

System Architecture Security Concept

A high level outline of how to make the system architecture compliant with any security policies. This can cover:

  • firewalls and firewall rules
  • security zones
  • local and general traffic managers
  • web servers
  • proxies and reverse proxies

System Risk Factors Identified and Verified

Any risk factors found in the risk assesment (or other reviews) are identified and assessed:

  • the level of risk implied in each one 
  • together with the estimated effort for any changes to the implementation that are required to address them.

Team is Aware of Success Definitions and Criteria

Confirmation that the entire team is aware of the success definitions and criteria.

Team is Aware of the Communication Plan

Confirmation that all members of the team are aware of who should be communicating with the customer, together with details of how and when.

Team Understands Project and Expectations

Alignment with the overall project and expectations, both internal to the project team and to the customer.

Technical Requirements

These requirements are specific to the technical implementation of services that support the solution.

Technical Risk Factors Verified

Identify and verify potential technical risks. Technical risks can include:

  • cross site scripting
  • end user facing input fields
  • infrastructure
  • technology age
  • number of integrations
  • and dependencies 

Technical Specification

The Technical Specification covers (amongst other information):

  • interfaces
  • configurations
  • APIs
  • services that support the requirements of the solution

Template Specification

The specifications for the required templates. These should cover details including parsys, blueprint and inheritance mapping, amongst others.

The specifications  are based on the Business Requirements and Experience Requirements.

Test Cases

Test Cases specific the detailed steps required to execute functional testing of the solution.

Test Content

The test content should be as close to production content as possible. It must be of a wide enough selection to allow for testing all scenarios.

Test Environment Ready

Ensure that the test environment is ready, with automated deployments in place to ensure that all release candidate code is up-to-date for testing.

Test Reports

Reports detailing the results of testing; including:

  • defects raised
  • status of test cases executed
  • other quality related topics

It should be noted that:

  • Any testing team should be allowed to remain neutral and deliver the testing results.
  • It is the responsibility of the Project Manager to assess any implications of the results and decide on appropriate action. 

Test Suite

Selection of the automation suite and tooling. These will be used to automate tests, including those for use cases.

Test Tooling Suite Selected

Automation suite and tooling selected for use case automation and other test execution tasks.

Testing Concept

The Testing Concept is the very high-level outline of testing for the project; including, QA, UAT, performance, security, and integration testing.

Testing Plans

These plans outline in greater detail the execution of tests for each phase of development and are based on the Testing Strategy.

Testing Scope

These requirements are specific to the technical implementation of services that support the solution.

Testing Strategy

The testing strategy outlines the high level strategy for quality assurance and user acceptance testing. This includes timelines, reporting cadence, and execution.

Third Party Integration Concept

Architectural and system level concept for the integration with third party systems.

Third Party Integration Specification

Details of the requirements (both functional and non-functional) for the supported functionality and integration of the third party systems.

Third Party Security Concept

Concept for ensuring the security of any third party integrations. Must be compliant with the appropriate security policies.

Third Party System for Integration

Ensure that all third party systems are available, with appropriate documentation, for integration implementation.

Third Party Systems Access Enabled

Required access rights granted to the respective roles used in conjunction with third party systems.

Third Party Testing Concept

Defines:

  • use cases for testing the integrations 
  • functionality related to any third party application

Threshold Definition

Defines the key values for monitoring points in the system.

For example:

  • how many kilobytes (KB) of unsent logs generate a warning on the principal server instance
  • the number of milliseconds of average delay per transaction that are tolerated before a warning is generated on the principal server

Timeline and Milestones

This should define the project timelines and contractual milestones to be used for:

  • Invoicing. 
  • Alignment against the success definitions, success criteria, and the KPIs.

Total Project Efforts

All effort estimates, from each of the leads on the project, should be consolidated; including, overhead, development, system engineering, architectural and testing efforts.

If there is a support level included in the agreement, support and operations efforts should also be included.

Training Materials

Materials to be used in training sessions. The materials should be created specifically for the solution and designed to be used in conjunction with the User Guides.

Understands Scope of Project and Expectations

The appropriate persona should confirm that they fully understand:

  • the scope of the project
  • all customer expectations
  • that this is the basis for all decisions made per persona, per phase in the project

URL Handling Concept

Your URL handling concept should cover AEM specific URL functionalities including:

  • vanity URLs
  • link externalizing
  • error pages
  • mapping

The concept should also cover:

  • any rewrite rules
  • virtual hosts on the web server
  • SEO considerations, such as robots.txt
  • a site map

Use Cases

A use case is the list of actions or event steps needed to achieve a goal. Typically they define the interactions between a role and the solution. The role can be a user or an external system.

Use Cases Converted into Test Scenarios

Test scenarios are based on the technical and business use cases. They are used to test that the solution behavior is as expected.

User Guides

User Guides provide information and assistance for the users of the solution:

  • authors
  • power users
  • administrators

Validated Budget Plan

The budget plan must be reviewed and validated by all stakeholders. They need to check details such as invoicing, amounts and methods/timing of budget reporting.

White Box Test Results

White box testing is a method that tests the internal structures or workings of an application, as opposed to its functionality. White box testing can be applied at the unit, integration and system levels of the software testing process.

Workflow Specifications

Based on the Workflows Concept, these specifications should define, in detail, the steps that will create the full workflow.

The specification of each workflow should include (at a minimum):

  • use case
  • roles
  • steps
  • outcomes
  • error handling

Workflows Concept

Workflows allow you to automate AEM activities. The Workflows Concept outlines:

  • the processes that will need automation
  • the services and roles in AEM that will be affected

Цей документ захищено ліцензією Creative Commons Attribution-Noncommercial-Share Alike 3.0 Unported License  Публікації Twitter™ і Facebook не підпадають під умови ліцензії Creative Commons.

Юридична інформація   |   Політика мережевої конфіденційності