SharePoint customized code analyzer

Microsoft SharePoint Online

Code Analysis & Submission Tool
Design Brief, Heuristic Evaluation &
UX Recommendations
Lisa Lane
Sr. UX Designer
23 July 2010

Microsoft

Online

team members
VIEW DESIGN BRIEF 

project description

RakeshPatnaik
Release Manager

KalyaniKoul

Program Manager

BalakrishnanShanmugam
Technical Architect
The current UX for the SharePoint Code Analysis and Deployment Tool is in need of
usability improvements. In general, the information architecture, navigation model and
content does not provide clear direction to the user and the UX is inconsistent with our
Design Goals and standardized UX Guidelines. In order to improve the overall usability
of this tool and increase customer satisfaction and online services market share we will:
•

Evaluate the current UX for the SharePoint Code Analysis and
Deployment Tool and provide recommendations for improving the overall UX
(Primary focus is to improve the Information Architecture and Navigation)

•

product
To install this tool on your desktop, click here.

Ensure that the UX is consistent with standardized UX Guidelines
(branding, icons, etc.) (Secondary focus)

•

UX Designer

Ensure that the UX is consistent with our Design Goals

•

LisaLane

Collaborate with the development team to implement these recommendations
in an effective and efficient manner

Microsoft

Online

problem statement
Currently, identifying and fixing errors in customized SharePoint code is a
fragmented and time-consuming manual process. The SharePoint Code Analysis
and Deployment Tool is being developed to provide Microsoft Online Service BPOS-D
IT Administrators/Developers (Customers) with an automated process for aggregating
customized SharePoint Code, analyzing the code, identifying code errors and fixing
these code errors prior to submitting this code to Microsoft Online Services
SharePoint Operations Administrators (Microsoft OPs) for further analysis and
eventual deployment to MSO SharePoint Farms/Internet Viewing.

Microsoft

Online

personas
Microsoft Employees
Microsoft Online Services Technical Account Manager (TAM)
Microsoft Online Services SharePoint Operations Administrators (OPs)
End Customers
Microsoft Online Service BPOS-D IT Administrators (IT Admin)
Microsoft Online Service BPOS-D Developers (Developer)

Microsoft

Online

user goals & benefits
The user goals and benefits of automating this process include:
•

Identifying code errors in the user’s customized SharePoint code and
providing an itemized list of these errors so that users can prioritize
and fix these errors prior to submission to ops

•

Higher quality customized SharePoint code

•

Decreased time spent by OPs in resolving issues with user’s
customized SharePoint code prior to deployment

•

Increasing the deployment speed/quantity of our user’s
customized SharePoint sites to MSO SharePoint Farms/Internet Viewing

•

Increased user satisfaction and online services market share

Microsoft

Online

heuristic evaluation
The heuristic evaluation that follows is based on Jakob Nielsen’s Ten Usability Heuristics.

NOTE:
In addition to the following evaluation this client-based application needs to
more seriously consider where is should surface in the end-to-end UX.

In discussion with SharePoint colleagues it has been recommended that this
application be developed as a Visual Studio plug-in since this is where users
create their customized code prior to analyzing, pre-deployment testing
and submitting it to Microsoft OPs.

Microsoft

Online

heuristic evaluation & recommendations
heuristic

evaluation (issue)

recommendation

1) Visibility of system status

There is no user visibility into the status of any one or multiple
customized SharePoint Sites.

Provide a list view so that users can easily access and see an
overview of their various customized SharePoint sites and their
status/progress (e.g. analyzed, code-free, submitted to MS,
deployed, etc.).

2) Match between system and the real world

This system is attempting to map to the real world and visualize the
overall process for submitting error-free customized SharePoint code
to Microsoft OPs, however the language used is confusing,
inconsistent and the steps are not clearly defined/labeled

Distinctly name each stage of the overall process. Use this
terminology consistently throughout the UX. If needed provide a
glossary of terms and show a visualization of the overall process.

3) User control and freedom

Existing system attempts to do this however, terminology and
illustrative quality are not clear.

Improve, IA, navigation, terminology and illustration quality.

4) Consistency and standards

UX does not map to UX standards for Wizard UI.

Map UX to standardized Wizard UX Guidelines.

5) Error prevention

In two specific instances (folder structure and the inclusion of the
customer’s Symbol files) users are sent down paths ill prepared and
will nearly always encounter an errors to fix their folder structure
and include their Symbol files.

Tell the users how to organize their file structure and where to
place their files in advance so they can avoid wasting time and
receiving an error message further in the project cycle when
there will likely be more files.

6) Recognition rather than recall

See no. 1 above + improve overall IA.

7) Flexibility and efficiency of use

See 8 below.

8) Aesthetic and minimalist design

Current design is attempting to provide various forms of navigation
and breadcrumb steps. However, the implementation is very
confusing due to the amount of information on the page.
Additionally, some pages include content that is distracting and
out of context for the step shown.

Remove extraneous content, show only the content that is relevant
to complete each step.

9) Help users recognize, diagnose, and recover from errors

This system provides this assistance, however the implantation
needs improvement.

Improve the hierarchy and taxonomy of the errors report. Make it
easier for users to understand each error and how to fix each error.

10) Help and documentation

Due to time constraints, Help & Documentation is not being
evaluated at this time.
The heuristic evaluation that follows is based on Jakob Nielsen’s Ten Usability Heuristics.

metrics
Specific Success Metrics identified in
PM Spec (PM SharePoint Site):
•

1. Code Analysis Mode utilized by:
• BPOS-D Developers (Developer)
• BPOS-D IT Administrators (IT Admin)

Achieve savings of > 75k in FY10; reach BEP in FY11 Q2

•

Reduce Microsoft testing by > 25% (average across customizations)
Reduce severity 1/2 defects prior to Microsoft engaging by > 25%

•

All customizations have the same test coverage

•

There are 3 separate use-case scenarios:

•

•

use-case scenarios

Reduce PA Customization HC COGS in 10.1 by 20%

Increase customer satisfaction by 5% (measured by survey)

2. Pre-Deployment Test & Submission Mode utilized by customers
• BPOS-D Developers (Developer)
• BPOS-D IT Administrators (IT Admin)
3. Post Submission OPs Mode utilized by:
• Microsoft Online Services SharePoint Operations Administrators (OPs)

Microsoft

Online

scenario overview
Analyzing customized SharePoint code and submitting to MS OPs
XYZ, Inc. has purchased BPOS-D and wants to create a customized SharePoint site.
XYZ, Inc. developers create customized SharePoint code and want to analyze it to see if
there are any code errors and ensure that their code is correct prior to conducting a
Pre-Deployment Test of their overall SharePoint site.
The developers individually analyze their code using this tool’s code analysis feature.
Once all the individual developer’s code is error-free, the code is aggregated by a
Technical Lead and a complete analysis and a Pre-Deployment Test is conducted to
ensure the code is error-free.
If additional code errors are identified, they are fixed and the customized code is
analyzed again until it is error-free. Once the code is error-free it is submitted to
Microsoft OPs for further analysis.
If errors are identified, the user is notified and fixes these errors and submits again to
Microsoft OPs. If no errors exist the customized SharePoint code is deployed to a MSO
SharePoint Farm/Internet.

Microsoft

Online

starting point
A customer wants to create a customized SharePoint site.
He contacts his Microsoft Technical Account Manager (TAM) for details.

The TAM sends an email to the customer that includes link to the
Deployment Guide for installing the SharePoint Online Code Analysis
and Deployment Tool.
The Deployment Guide includes instructions for organizing their
files using a specific folder structure.

Microsoft

Online

Page should be updated to adhere
to O14 placement and branding
guidelines.

Wizard should be updated to
adhere to O14 application
installation UX Guidelines.

installation complete
User accesses application via start menu.

current splash screen
Recommendation

Once the correct home is identified we’ll need to rethink where this tool is installed and launched.
The SharePoint Team has recommended that we consider making this a VS Plug-In so that this task

(goes away if this is a plug in… we may need stand
alone and plug in versions one for user and one for ops.
For now, we’re creating a standalone app that feels like
a VS-Plug minimally branded as SharePoint Online.)

surfaces after a user has completed implementing their SharePoint Online customizations.
However, this may be problematic since Microsoft OPs needs to only test the code again
prior to deployment.

current location

Need to update Splash Screen.
You can find all the resources
produced for O14 splash screens
here…
ipoodgfs101publicmarkpearUI
_In_MotionbootAnimationFiles_R
TM

Need to determine
appropriate location,
branding and app
name.

Contacts:
Robyn Yoder
Mark Pearson

Microsoft

Online

Microsoft SharePoint Online Code Analysis & Submission Tool

Code Analysis & Submission Tool

Get Started!
Submit your customized SharePoint site today
The SharePoint Online Code Analyzer & Submission Tool analyzes your customized SharePoint code
and generates an error report so that you can prioritize, track and fix errors in your code.
Additionally, you can perform Test Deployments and once your code is error-free you can
easily submit it to Microsoft Online Services for final deployment . Learn More

What would you like to do?
Analyze

code to identify, track
and fix code errors

Test Deployment
for your customized
SharePoint code

Rollback

deployment to
previous version

Submit

error-free code to
Microsoft for
deployment

Analyze

|

-

| c | r |

Set your code up for success!
Click Download to copy of the mandated folder structure to your desktop.
Ensure your files are placed in the appropriate folders and Click Next.

[ Download ]
Mandated folder Structure
Folder Name 5

Description of folder contents

File Types Permitted

 Root

Contents of this folder will be packaged.

NA

 Installation Scripts

Installation files for deploying the Solutions and other pre/post deployment steps.

.ps1, .exe, .bat , .cmd

 Release Documents

Deployment document to be provided in the Microsoft Operations (MSO).

.doc, .docx , .xml

 Solutions Artifacts

 Cab File

Ideally the directory will contain only WSP package(s). If a directory contains .wsp
packages along with independent assemblies, CAF will analyze them and list their
reports under Outside Package in the report. However if the Customization review
team finds that the independent assemblies can still be packaged as wsps, then the
customization will require a re-drop.
The CAB file will be automatically generated after you run the following solution
packages folder with CAF, and complete the analysis.

.wsp

.wsp, .exe , .dll , .stp, .xml

 Source Code

Complete source code for the customization drop for this deployment.

Any

 Test Documents

Provide all the test case documents run per the “Microsoft SharePoint Online – Test
Cases” document. If there are any manual test cases to be verified, please provide
that test case document with results.

Any

[ X ] Skip this message in the future, I’ve downloaded a copy this folder structure to my desktop.

[Back ] [ Next ] [ Cancel ]

Analyze

|

-

| c | r |

Test Cases
Below is a list of the Test Cases that will be used to analyze your code. Click Next to continue.

Test Cases
Category

+ Design
+ Globalization

Description
These test cases contain FxCop rules for each of these areas.

+ Interoperability
+ Mobility
+ Naming
+ Performance
+ Portability
+ Usage
+ Memory Management

This test case contains Memory Management rules

+ Security

This test case contains FxCop Security and CAT.Net rules

+ Microsoft SharePoint Online Custom Rules

This test case contains SharePoint object model usage rules.

[ X ] Skip this message in the future, I’ve downloaded a copy this folder structure to my desktop.


Analyze

|

-

| c | r |

Analyze your code
Enter a Project Name bel ow a nd then cl i ck Browse to choos e the di rectory
of the code you wa nt to a na l yze. Cl i ck Analyze to begi n a na l yzi ng your code.

View Details: [ Export to Excel ] | HTML

[ Test Cases ]

Choose a directory: [

] [ Browse ]

Filters: Packages: [ Show All
Name 5

v]

Test Cases: [ Show All

v]
Status

Line No. Rules Run Passed Warned Justified Failed Exceptions
^

=

1

1

ll

<

[ Help ]

>

[Back ] [ Analyze ] [ Cancel ]

v

Analyze

|

-

| c | r |

Analyze your code


[ Test Cases ]

Choose a directory: [ // Root

] [ Browse ]
v]


Name 5
-

v]
Status


 Root

^


=

 Filename.ps1
+


-


+

 com.GSK.IT.EUS.IW.Platform.EntLibDeploy.wsp

-

 Source Code

• Filename.cs

-

 Test Documents

ll

<

[ Help ] [ Preview ]

>


v

Analyze

|

-

| c | r |

Analyze your code


[ Test Cases ]


] [ Browse ]
v]


Name 5
-

v]
Status

 Root


a
a
a
a

-


O

+


Extraction successful.

^


-

 Filename.ps1

+

-


=

45% Extracted

 Source Code

• Filename.cs

-

 Test Documents

ll

<


>

[Back ] [ Stop Analysis ] [ Cancel ]

v

Analyze

|

-

| c | r |

Analyze your code

x 2 errors found. Cannot perform code analysis until these errors are fixed. For details, see status column below or View Details in Excel or HTML.


[ Test Cases ]


] [ Browse ]
v]


Name 5
-

v]
Status

 Root

a
a
a

 Filename.ps1

+


-


-

Missing folder & files

x

^

Extraction failure


=



+

x



 Source Code

• Filename.cs

-

 Test Documents

ll

<


>


v

Analyze

|

-

| c | r |

Analyze your code

x 1 error(s) found. See status column below or View Details in Excel or HTML.


[ Test Cases ]


] [ Browse ]
v]


Name 5
-

v]
Status

 Root

+


-


-

 Source Code

^

x

+


a
a
a
a

-

 Filename.ps1

 Test Documents

ll

<


32 instances found.

114

113

0

0

1

0

a
a
a


• Filename.cs
-

x

=

>


v

Analyze

|

-

| c | r |

Analyze your code

x 1 error(s) found. See status column below or View Details in Excel or HTML.


[ Test Cases ]


] [ Browse ]
v]


Name 5

v]
Status

-  com.GSK.IT.EUS.IW.Platform.EntLibDeploy.wsp

x

Line No. Rules Run Passed Warned Justified

32 instances found

114

113

0

0

Failed Exceptions
1

0

^

Test Cases Categories
-

=

Design
Do not declare static members on generic types
Types that own disposable fields should be
disposable
Do not expose generic lists

x

16 instances found
Do not expose <T> in object models. Use Collection<T>,
ReadOnlyCollection<T> or KeyedCollections<K,V>
instead. List<T> is meant to be used from
implementation, not in object model API. List<T> is
optimized for performance at the cost of long term
versioning. For example, if you return List<T> to the
client code, you will not ever be able to receive
notifications when client code modifies the collection.
Get All Configuration Values ()
Get All List Items (System, String)
Get All Navigation Localization (System, Int32)
Get All Search Scopes()
Get Configuration Value (System , String, System,
String, System, String)
Get Cultural Codes()

ll

<


345

Comment

234

Comment

2345

Comment

689

Comment

329

Comment

357

Comment
>


v

Analyze

|

-

| c | r |

Analyze your code

a No errors found. Click Next to enter your Pre- and Post-deployment requisites.

[ Test Cases ]


] [ Browse ]
v]


Name 5
-

 Root
 Filename.ps1

+


-


+


-

 Source Code

• Filename.cs

-

 Test Documents

ll

<


v]
Status

a
a
a
a
a
a
a
a
a

114

114

0

0

0

0

^

=

>


v

Analyze

|

-

| c | r |

Pre- and Post-deployment requisites
Enter your pre- a nd pos t-depl oyment requi s i tes bel ow a nd cl i ck Save.


] [ Browse ]

Pre-Deployment Requisites

Post-Deployment Requisites

- Actions

Actions

Software Installation : Install Aviva World Release 1.7.2
Software Installation : News Forum Rollup 1.1.3

Software Installation : Leading People Survey 2.1.3

Run stsadm command
Run the Resource File Deployment Script
1. From a command prompt on the current production index server or WFE, execute the
DeployResources.cmd file
2. Please watch the console to ensure there are no errors
3. If errors should occur, copy the console output, and mail it to the CoE
(AvivaMSO@avivausa.com

^

=

[ Add Row ]
- Verification

Verification

Ensure the variable STSADM points to the folder (on this server) where your
stsadm.exe is located, for example:
SET STSADM="%ProgramFiles%common filesmicrosoft sharedWeb Server
Extensions12binSTSADM.EXE"

Verify that Leading People Survey 2.1.4 deployed properly
1. Display the GAC by typing “assembly” into the File > Run dialog
2. Locate the dynamic link library named: Aviva.OneIntranet.LeadingPeopleSelect this file,
right mouse click and select Properties
3. On the Version tab, the File Version should be identified as: “ 2.1.4.0 “

[ Add Row ]
- Attachments

Choose a file to attache: [ XYZ.doc

] [ Browse ]

XYZ.doc

ll

<

[ Preview ]

>

[Back ] [ Save ] [ Cancel ]

v

Analyze

|

-

| c | r |

Pre- and Post-deployment requisites
Enter your pre- a nd pos t-depl oyment requi s i tes bel ow a nd cl i ck Save.

a Your Pre- and Post-deployment requisites have been saved in your Release Documents folder (.xml). Click


Next to run a test deployment.

] [ Browse ]


Post-Deployment Requisites

- Actions

Actions



Run stsadm command
Run the Resource File Deployment Script
1. From a command prompt on the current production index server or WFE, execute the
DeployResources.cmd file
2. Please watch the console to ensure there are no errors
3. If errors should occur, copy the console output, and mail it to the CoE
(AvivaMSO@avivausa.com

^

=

[ Add Row ]
- Verification

Verification


Verify that Leading People Survey 2.1.4 deployed properly
1. Display the GAC by typing “assembly” into the File > Run dialog
2. Locate the dynamic link library named: Aviva.OneIntranet.LeadingPeopleSelect this file,
right mouse click and select Properties
3. On the Version tab, the File Version should be identified as: “ 2.1.4.0 “

[ Add Row ]
- Attachments

Choose a file to attache: [ XYZ.doc

] [ Browse ]

XYZ.doc

ll

<

[ Preview ]

>


v

Analyze

|

-

| c | r |

Pre-deployment requisites
Ens ure tha t you’ve compl eted a l l of the pre-depl oyment requi s i tes by checki ng the boxes bel ow.
Cl i ck Run Test Deployment to begi n your tes t depl oyment.

[ Modify ]

] [ Browse ]


Complete

- Actions


- Verification

^

[a]
[a]
[a]


=

Verification


[a]

- Attachments
XYZ.doc

ll

<

[ Preview ]

>

[Back ] [ Run Test Deployment ] [ Cancel ]

v

Analyze

|

-

| c | r |

Test Deployment
Cl i ck Run Test Deployment to begi n your tes t depl oyment.

x 1 error(s) found. Please review the log file located here: C://Root/Logs_Files/CAAD.logs. You must fix any errors before you can proceed.


] [ Browse ]
v]


Name 5

v]
Status


x

Deployment failed.

Description
SharePoint solution package containing enterprise library.

^

=

ll

<

[ Preview ]

>

[Back ] [ Run Test Deployment ] [ Cancel ]

v

Analyze

|

-

| c | r |

Test Deployment
To run a tes t depl oyment, cl i ck Next.

a Deployment complete.


] [ Browse ]

Name 5

Status


a

Deployment complete.

Description
SharePoint solution package containing enterprise library.

^

=

ll

<

[ Preview ]

>


v

Analyze

|

-

| c | r |

Post-deployment requisites
Ens ure tha t you’ve compl eted a l l of the pos t-depl oyment requi s i tes by checki ng the boxes bel ow.
To conti nue, cl i ck Submit.

[ Modify ]
Directory: [//Root

]


Complete

- Actions

[a]


- Verification

^

[a]


=

[a]
Verification


[a]

- Attachments
XYZ.doc

ll

<

[ Preview ]

>

[ Back ] [ Next ] [ Cancel ]

v

Analyze

|

-

| c | r |

Submit your error-free code to Microsoft Online Services
Enter your i nforma ti on bel ow a nd cl i ck Submit.


] [ Browse ]

Customer Information

Name:

[

]

Email address:

[

] If your submission fails to deploy, you will be notified at this address.

Phone Number:

[

]

Change request number:

[

]

Password:

[

]

Agreement

^

Area

Description

Packaging

Folder structures in the submitted customization package are created according to Microsoft Online (MSO) guidelines.

Documentation Integrity

All submitted documents open up without any error.

Documentation Completeness

Submitted documentation including Deployment and Troubleshooting Guides (TSGs) conforms to MSO templates.

Pre-Requisites Information

The ‘Prerequisite Software’ section in Deployment document is filled out correctly and accurately.

Revision History
Error Handling and Monitoring

=

If this submission is a revision over a past submission for this customization package, the deployment guide documents the revisions over
the previous version
Custom event code documentation is included in the monitoring section of the Deployment Guide. Troubleshooting Guides (TSGs) have
been submitted that include corrective actions to be taken in case of occurrence of such events.

Change Control

There are no new changes introduced in this customization, which are not part of the approved HLD.

Post-Deployment Validation

All post-deployment validation activities required to be performed by MSO, are documented in the Deployment Guide

Roll Back

All activities required to rollback are documented, along with screenshots of environment before rollback and after-rollback.

Use of Open Source Code

This customization uses open source. I accept responsibility for use of any open source in the customization.
v

Confirmation

[a] I confirm that I have reviewed the above terms, and I agree that MSO reserves the rights to reject this customization package, if any
non-conformance is observed.

ll

<

[ Preview ]

>

[Back ] [ Submit ] [ Cancel ]

SharePoint customized code analyzer

Recommandé

Recommandé

Contenu connexe

Tendances

Tendances (20)

En vedette

En vedette (20)

Similaire à SharePoint customized code analyzer

Similaire à SharePoint customized code analyzer (20)

Plus de Microsoft

Plus de Microsoft (7)

Dernier

Dernier (20)

SharePoint customized code analyzer