Insights

View full profileRichard Labib

SAP Solution Manager Stream Lead
Bluefin Solutions

Do you feel the pain of change? Part II - Solution documentation

13 Dec 2011 Project Management & Methodology, SAP Solution Manager, Consumer Business

In Part 1 of this blog series I discussed how SAP Solution Managers Business Process Change Analzer can be used to reduce the pain of change impact analysis. Here I'll look at how we can maintain our solution documentation during change, and the final blog I'll look at how changes can be tested.

The pain of change

One of the 'simple' aspects of making a system change is the actual execution of the change.  For example how long does it actually take to implement a new Enhancement Package for SAP ECC 6.0? I've  have always seen that the actual time to perform the technical work is a small percentage of the total project duration, and this is because it is often a complicated process to identify the change impact, plan and create solution documents, document and execute our tests.

It's always been a key challenge to understand which business processes are impacted when a support pack or enhancement pack is introduced.  As discussed in the first blog we can use BPCA to identify the business processes that are impacted by change.  But once we know this we then need to understand which documents need to be updated, and where these documents can be located.

For many organisations solution documentation can be located across multiple systems, databases, or even a combination of manual and electronic mediums. A good example of 'documentation pain' can be seen within organisations that insist a new "project team room" is used to store documentation relating to the project.  The result is often that a team room will be used to store documentation relating to the solution, for example a blueprint document, technical documentation and even test documentation.  After some years the organisation can be in a situation where they need to look in multiple team rooms to find the documentation relating to a business process that is going to change.

Solution documentation

Within SAP Solution Manager we have a Solution Directory.  The Solution Directory is often seen as the heart of the application because it is the basis for many SAP ALM processes.

PainOfChanceII(11)

The Solution Directory documents our productive solution landscape.  Within the Solution Directory we can document our business process hierarchy, blueprint information, configuration and development objects and our test documentation to name a few.

During each project we can use SAP Solution Manager as our storage location for all our documents. This would typically include our business requirements, business blueprint, test cases and other project deliverables. This documentation is process orientated, meaning that the documents are assigned to a business process in the business process hierarchy.  At the end of the project we can move our Solution Documentation to the Solution Directory.  This then provides a central location to store our solution documentation that reflects the productive use of the system.

PainOfChanceII(2)

When we identify the business processes that are impacted by the change we can then use a maintenance project in SAP Solution Manager to check-out documentation in our Solution Directory so that it can be updated.  This can be completed on a process by process basis, meaning that one or many processes can be checked out so that they can be updated.

PainOfChanceII(33)

Once the updated documentation has been released, and the change implemented, we can check-in our modified documentation. This ensures that our solution documentation is always current.

So our first pain point was to understand what has been impacted by change, and we have the BPCA that can tell us this.  Next we need to update all our solution documentation, and we can use the Solution Directory to store the documents, and control the on-going maintenance.

So in the final blog in this series I'll look at the process of testing the change that has been identified and now documented.



Comments

Richard Labib 12 Jan 2012

Hi Kelly,

I think there are a number of factors to consider when deciding to copy or refer to documents in the Solution Directory.

Some regulated industries will require organisations to have a transparent document flow or audit trail. In this case there is only one option and this is to refer to the source document rather than making a copy. This is because the document flow can be lost between copies.

You may also want to consider the archiving policy for your organisation. If you refer to a document and every year closed projects are archived in Solution Manager then can you still gain access to the refered source document.

The only advice I can give is that you need to understand the requirements of your project / solution documentation life cycle and then make a decision based on these requirements. There are clear pro's and con's for both approaches.

Kelly 03 Jan 2012

Richard - Thank you for the information, that helps.
Once more question for you , is it "best practice" to copy the documents into directory or refer to them?

Richard Labib 03 Jan 2012

Hi Kelly,

Within the configuration settings for Document Management you define the release process for a given document type. Within the Status Schema for the document type you can add the released status and define the signature strategy. This will allow you to configure the full release process.

Within the Solution Settings you can define how documents from a project are copied into Solution Directory. You can copy documents from a Project, which will mean a new version of the document is created, or you can refer to a document, which will create a link to the source document.

If you copy a document into the directory you will need to complete an additional release process, which is not ideal. If you refer to a document an additional is not required.

Kelly Timmons 19 Dec 2011

How do I get the documents to a released status? This status was not part of our original electronic signature approval during the implementation project. Therefore, now that I have the docs copied into the directory, I cannot figure out how to get them released. Any insight would be greatly appreciated.

Add a comment