Home  >  Posts  >

How To Write Your Own UX Plan

Make a technical UX document to compliment design artifacts for coding.

Article • Feb 2017 • 15 min read

Last month, I wrote about how our team started raising the bar of our user experience design efforts over the last two years. From those efforts, we identified and shaped a new UX design deliverable that’s become core to our process—the UX Plan.

This week, our lead senior product designer, Noah Stokes, posted an article about UX Plans called How I Design with Dropbox Paper or How the UX Plan was Born. It captures what the UX Plan is, why we created it, and how it’s helped us improve our process, collaboration, and user experience work in our product design.

This article is a technical onboarding document that can help you write your own UX Plan. It captures the detailed structure and syntax that we use.

If you’re interested in adopting this deliverable for yourself or your team, open the two reference documents below and read on!

Documents for use and reference:


Inline vs. Separate UX Plans

Setting Up A New Doc

Using Emojis

Writing the Summary

At the top of every UX Plan is a project summary. Each piece of information provides updates on what the deliverable is and where it was left off. This makes it easy for anyone to jump in, get some context, and understand the design intention of a product project.

Building Page & User State Sections

Now, let’s begin building a new UX plan. Start by listing out all of the Page States and User States that a project intends to impact or needs to have designed. Whether it’s new feature or an update to an existing page or flow, capture the hierarchy of your states using a simple numbered list using the following format pattern:

Page States

User States

User State Summary Table

Definition and options for each row are as follows:

Filling in the Content States

Ok. Now comes the most important step: filling in the Content States. The goal of adding information into the Content State under each User State is to be as prescriptive and simple as possible.

You’ll be planning all content that you intend to produce wireframes and/or visual comps for by listing them out as you intend them to display on the page in a top-left to bottom-right hierarchy. Simple, right?

The Approach

Building the Bullet Lists

Allow for up to 4 tiers deep of bullets. If you can’t prescribe and define everything in under 5 tiers of bullets in your list-making, then try to scale back the level of detail in the Content States area.

Content Features Level

In order to make the bullet list syntax easier to consume, begin with listing and underlining the primary Content Features (think modules, divs, tools, or sections) on the page at the first level of the bullet list. Add all of them that you can think of in order to create an initial outline for the page. You may miss some of the hidden interaction states, but they’ll reveal themselves as you dig in and build your UX Plan.

For projects in which you’re only adding or editing existing page states, it’s recommended to put an inline note at this level to ensure that the content is located on the page in relation to other pieces of content around it.

We use titlecase and underlining for these Content Features. You’re allowed to use parenthesis or a colon if you need to add more label clarity about the Feature you’re describing. If there’s something unique to call out, make sure it’s in the label. As you list all of your Content Features, they should be in the same hierarchy order that you intend to place them in the page layout. You can use labels such as “Grid”, “Module”, or “Tool” to define the type of content that might be defined in each Feature section.

Here’s an example of what a few Content Features looks like in hierarchical Page State order:

Content Element Level

Then, fill in the next level of bullets with Elements such as copy, click triggers, brand visuals, product thumbnails, and more. At this level, the goal is to truly define and prescribe the actual user interface content (read: Content Elements) on the page. If you require brand, copy, tracking on any element, add in the corresponding emoji at this level. This will flag the project team on additional needs inline so that work can be requested and begin as soon as possible.

Element Writing Syntax: Particular elements have style and functionality considerations that yoy may define require subtle text treatments to subtly stand-out in the outline. Here are the most commonly used conventions:

Using one of the Content Features from section above, here’s an example of adding in Content Elements with emojis looks like:

Content Interaction Level

Next, add in Content Interaction at the next level deeper of bullets. At this level, you should prescribe functionality and interactions with buttons, controls, etc., and start to unpack the experience behind the user interface.

There are two commonly used conventions, which are as follows:

Using our same example, here’s a look at the next tier of bullets that capture interaction states:

Four tiers deep of bullets within your Content States details should be sufficient. If you have to go to a fifth depth of bullets, then you might be providing too many details. Use what you need, but if you have 12+ interaction bullets for each Content Interaction bullet, you might be using the framework poorly by over-detailing the work.

About Complex Content Interaction Variations

If you find yourself creating one or more contextual variations at the Content Element or Interaction levels, it’s a good idea to break them out into their own User State section. It’s not ideal to tech-tree lots of User State variations at the Element or Interaction levels that require design deliverables.

Feedback

As you collaborate with the product manager, product team, design team, etc. in building the first (and subsequent) version(s) of a UX Plan, it’s a good idea to solicit for and roll in approved feedback inline in this document. We encourage collecting feedback through two approaches.

Approach A: Inline Comments

Approach B: Meeting Feedback

[Optional] Post Project Visuals Archiving

Lastly, if it’s helpful to the project team, it’s ok for a product manager or designer to post the latest visual comps that we built and shipped against this UX Plan inline at the bottom of each User State area. The comps should be scaled down to thumbnail size and still be clickable to zoom to up to 100%. This visual comp inline archiving can help viewers visualize complex bullet lists within the Content States more quickly and easily.

[Optional] Post UX Plan Creation QA Test

After the UX Plan, visual comps, and design/dev protoype has been created, you can come back to the UX Plan and add QA emojis to create a quick QA plan for the team.

If you aren't familiar with UX Plans and want to learn more, head over to Noah's post How I Design with Dropbox Paper or How the UX Plan was Born.

I hope that you found this UX Plan Rules document helpful! If you have questions or needs, feel free to reach out to Noah or I for help.