Design SharePoint Add-ins

SharePoint Add-ins

Get an overview of the design and architecture options that are available in SharePoint Add-ins, and learn how to make the right decisions to ease the development of your add-in in SharePoint 2013.

Last modified: September 17, 2015

Applies to: apps for SharePoint | Office 365 | SharePoint Add-ins | SharePoint Foundation 2013 | SharePoint Server 2013

Note Note

The name "apps for SharePoint" is changing to "SharePoint Add-ins". During the transition, the documentation and the UI of some SharePoint products and Visual Studio tools might still use the term "apps for SharePoint". For details, see New name for apps for Office and SharePoint.

In this article
Start designing SharePoint Add-ins
Choose the right hosting model for your add-in
Choose the right data access technologies for your add-in
Design the UX for your add-in
Design with update in mind
Next steps: Develop and publish your add-in
Additional resources

Let's say you have a killer idea for an add-in. In this section, we'll guide you through the design decisions you need to make and offer best practices to build your add-in. For example, what makes a good user interface? What are the add-in "shapes" available? When should I use one instead of another? What options do I have for data access?

Because the Cloud Add-in Model in SharePoint 2013 makes so many design options possible, SharePoint Add-ins can come in many shapes and sizes. This section contains helpful guidance for some of the most important decisions that you need to make as you are planning and designing the architecture and user experience of your add-in—including how you will host your add-in, how your add-in will efficiently and securely access data, and what the user experience will be.

For an overview of the design and architecture options that are available with SharePoint Add-ins, see Three ways to think about design options for SharePoint Add-ins. For an overview of what SharePoint Add-ins are, see SharePoint Add-ins.

SharePoint Add-ins support multiple hosting options. You can choose your own web stack, have Microsoft provision Microsoft Azure and SQL Azure, or have the add-in hosted on SharePoint. Table 1 contains resources that can help you choose the right hosting model for your add-in.

Table 1. Resources and guidance for choosing the right hosting model for SharePoint Add-ins



Choose patterns for developing and hosting your SharePoint Add-in

Learn about the different ways that you can host the components of SharePoint Add-ins.

You must ensure that your add-in accesses data efficiently and securely. Various data access technologies are available for accessing SharePoint and working with data in your add-in. Table 2 provides resources to help you learn about your options and choose the one that is right for your add-in.

Table 2. Resources and guidance for choosing the data access technologies to use in SharePoint Add-ins



Secure data access and client object models for SharePoint Add-ins

Learn about data access options you have when you build SharePoint Add-ins, including data connectivity options for inbound and outbound data scenarios, and the APIs that are available when you want to access SharePoint data from your add-in.

As you design your add-in, your real goal should be to create an experience that enables users to complete the scenarios that you intend for them to accomplish. In Table 3, discover the resources and design guidance that you need to build great add-ins that follow best practices for user experience design and have the familiar appearance and behavior of SharePoint 2013.

Table 3. Resources and guidance for designing a great user experience for SharePoint Add-ins



UX design for SharePoint Add-ins

Learn about the user experience options that you have when you build SharePoint Add-ins.

Someday you may want to produce an update of your add-in and upload it to the Office Store or an organization's add-in catalog. That task will be a lot easier if you think about how you would update the add-in while you are designing the first version. We recommend that you read the following articles early in the design phase: SharePoint Add-ins update process and Update SharePoint Add-ins.

Have a solid design for your add-in? Get ready to build your add-in and publish it. The resources provided in Table 4 can help you get started.

Table 4. Resources and guidance for developing and publishing SharePoint Add-ins



Develop SharePoint Add-ins

Discusses advanced concepts and capabilities of the add-in model.

Publish SharePoint Add-ins

Describes the process and requirements for publishing SharePoint Add-ins.

© 2015 Microsoft