12/16/2024 | News release | Distributed by Public on 12/16/2024 06:34
Updated: December 16, 2024
Published: December 14, 2024
I once served overcooked turkey on Thanksgiving because the recipe listed a temperature that was way too high. What does this have to do with website design documentation? Let me explain.
Just like I relied on that food blog to tell me the exact temperature for the juicy turkey my guests had hoped to eat, developers rely on design documentation to tell them the specifications of the website you envision. Could they build something without good documentation? Sure. Should they? Not if you want it to turn out right.
It's "like a recipe of a cookbook," says Juan Manuel Devia Pinzon, a HubSpot UX designer who, during our interview, placed a hand over his heart and said, "I love design documentation." I hope by the end of this article, you'll feel that way too.
Table of Contents
Strictly speaking, web design documentation refers to the guidelines and specifications that designers send to developers so that the latter can build the website. This documentation includes text, images, wireframes, and mockups that detail how to create each design element.
As a freelance tech writer for over a decade, I've come across all sorts of documentation, but design documentation isn't in my wheelhouse. So I tapped my network of talented HubSpot designers and developers as well as an external expert to do research for this article. I learned so much!
Pinzon really helped me understand why design documentation matters. As he put it, "How can we [designers] translate our thinking process to someone to then put it on the website? That is what the documentation is for."
In other words, developers can't read your mind; documentation is the next best thing. Should the container height of a button be 40dp? Should the hero image have a ripple effect when a user clicks it? These specs should be included in the documentation so developers can build it.
77 Brilliant Examples of Homepages, Blogs & Landing Pages to Inspire You
All fields are required.
Web design documentation may also be shared with other designers or the client to ensure everyone is on the same page about how the website will look and function.
Here's an example of low-fidelity wireframes that a designer might use to communicate their ideas early in the web design process to a client, other designers, or their development team.
Here's a medium-fidelity mockup, which has more detail:
And lastly, here's a high-fidelity mockup, a fully-designed website minus the interactivity:
Web design documentation can dictate the guidelines of a particular project, such as a website redesign for an agency's client, or it can refer to an entire design system that governs all website projects within a brand to maintain a cohesive brand identity.
Here's a design system example from Skyscanner. It details how to use specific brand icons, down to the exact pixels for padding.
More broadly speaking, people may use "web design documentation" to refer to the guides that web design agencies send to their clients (the website owners) so that they can edit and maintain their new websites.
For instance, here's some documentation for the HubSpot Focus theme, which tells website owners and editors how to use the Cards module and why they might want to:
As you can see, web design documentation can take many forms for many audiences. In essence, however, it mainly describes how a website should look and function.
Most commonly, designers and developers need web design documentation - but they're not the only ones. Here's a breakdown of the many stakeholders in a web design process who might need access to documentation and the reasons why.
Web designers create web design documentation so they can communicate their ideas and web design strategy to:
Web developers need web design documentation to understand the specifications of what they need to build.
Website owners need web design documentation to understand how to use and maintain their websites. This really applies to anyone who will edit the website, such as marketers and writers.
The website design doc that website owners will consult could include wireframes from their web design agency's design team or the documentation for a WordPress theme they purchase in an online marketplace.
Good website design documentation shouldn't leave the developer guessing. If it does, the developer either has to go back to the designer and ask questions (slowing the development process), or they'll simply make a guess - and they might guess wrong (again, slowing the development process because they'll have to redo it).
For example, a static website mockup might show a grayed-out toggle on a form. Easy enough. But if you want that toggle to turn blue when a user checks it, you must communicate that in your design documentation, like Mews does here:
Design system documentation is particularly important for brand identity. It also makes designing and developing faster since it contains repeatable elements that designers and developers can copy-paste.
Websites are living, breathing things. Okay, not literally - but they are constantly changing. What happens if two years down the line, a user reports a bug but no one on the design team remembers how the feature was supposed to behave?
"We go back to the design documentation, and we check it," says Pinzon. "And we say, 'You know, it's been written down here that this behavior should happen' - or the opposite."
"Some projects take months," says Pinzon, "and something that you did two months ago, the development team is just now getting ready to pick up."
Website design documentation provides an easy reference point for designers to remember why they made the decision they did, even if it's months later.
By that point, too, there may be different designers on the project. Web design documentation ensures continuity, providing a single source of truth that designers and developers can continually reference to ensure the website is functioning according to the specifications, regardless of who is on the team at that point.
77 Brilliant Examples of Homepages, Blogs & Landing Pages to Inspire You
All fields are required.
When creating web design documentation to hand off to developers, you need to consider the scope of the project. If it's a simple website project, like a one-time splash landing page, you can just send a mockup and have your developers build it.
"At the very least, designers should be handing off well-designed/defined mockups of what the site should look like along with notes," says Kyle Brigham, chief strategy officer of Chicago-based web development agency Marcel Digital.
"Ideally, they would utilize global elements to ensure that designs are consistent across templates and components, and provide any notes on functionality/expected experience that the developers can utilize to shape the website."
For more complex projects, like a multi-page website, you might want to include the following in your website design documentation:
Here's an example of accessibility notes from the design system documentation of Zinnia:
"More advanced projects may require that the designs be full fidelity so the user experience can be emulated in a design program, such as Figma," Brigham explains. "This helps to show how the website will work to the end user but also helps to better articulate functionality to developers.
"Some designers will only hand off designs; others that are more technically adept may have the ability to hand off well-constructed HTML/CSS to even better define how the pages should map to the website."
Pro tip: Figma's Dev Mode makes it easier for designers and developers to work together and can speed up development time by providing necessary details and code snippets for the design files.
If you're a marketer requesting a mockup from a designer, you don't need website design documentation.
"As a designer, I would be a bit confused if a marketer came to me with design documentation," Pinzon told me. "Kind of like a realtor coming to an architect with blueprints."
In home building, the architect is responsible for creating blueprints for the builders. Similarly, in website building, the designers are in charge of creating web design documentation.
If you're a non-designer trying to communicate an idea to a design team, what you really need is a web design brief.
"Preparing a document like this is a great way to help fast track these early stages of your web design project," writes Australia-based Blis Web Agency. "It allows our web design team to quickly understand how long they have to deliver the website, what your website needs to do and how much your company can afford to invest into the new website."
Lucky for you, Pinzon put together a web brief template with the help of generative AI, so you don't have to start from scratch. The goal of this web design brief is to help marketers, website owners, and other non-designers communicate what they need a web designer to create.
Feel free to save the image below or use it as inspiration. For the "Design and Layout" section, read how to create a wireframe and check out these free web design tools.
Alternatively, you can simply screenshot examples of webpages you like and send them to the designer for inspiration.
If you're a designer selling your web design services to a client, you can use this free website proposal template to close the deal.
As you create website design documentation, follow these best practices that I learned from both designers and developers.
Like journaling, creating documentation forces you to think through your process now, helping you to remember and explain your choices later.
"When we are designing something, we're making decisions in our minds as designers," says Pinzon. "If we don't write those down, we're going to forget why we decided on something."
Pro tip: Create design documentation templates so your team can easily copy and build upon them for each project rather than start from scratch. Figma is a popular tool for this.
77 Brilliant Examples of Homepages, Blogs & Landing Pages to Inspire You
All fields are required.
I wanted to make sure to get a developer perspective in here, so I asked HubSpot Principal Developer Nhori Lopchan-Edmonds what she wishes designers knew about web design documentation.
Her response? "Prioritize clarity and detail about functionality, not just aesthetics."
As Lopchan-Edmonds explains, "While visuals hold significance, it's crucial for developers to have documentation that thoroughly explains the behavior of interactive elements like buttons, animations, hover states, and forms. This includes specifying:
This revelation surprised me most: Designers shouldn't expect a pixel-perfect copy of their mockups to make it to production. In fact, they should avoid using pixels in their documentation when possible. Instead, opt for responsive units.
"While a static design might not translate perfectly to the front end due to differences in screen sizes, resolutions, and browser behaviors, responsive units empower elements to fluidly adjust to diverse environments," says Lopchan-Edmonds.
"These slight deviations from the original design are embraced for fostering usability and accessibility, emphasizing that achieving a seamless user experience is more important than a meticulous pixel-to-pixel match. The use of pixels (px) should be minimized, restricted to implicit components such as border-radius or base font-size. "
Documentation isn't a replacement for consistent communication. Ideally, your designers and developers touch base throughout the web design process - not just when it comes time to build.
"You have to work with your designer and your developer to make sure that they're on the same page about what documentation is going to be handed off to the development team," Brigham says.
He explains that there are many different levels of documentation that a designer could create, from mockups with minimal annotations to full-fidelity designs with CSS and some coding. Having some insight into what will eventually be handed off helps developers scope the project.
Brigham adds, "Getting those two teams aligned with what the final documentation is going to be when the design files are handed off to the development team is going to be important in planning, in determining what your scope is going to look like for both of those teams, and for making sure that you are being as efficient as possible with your timeline and that there aren't any surprises."
Pinzon agrees. "The developer shouldn't be surprised when they get something handed over. They should know what is happening."
And if they don't know what's happening? Well, the developer might shoot down your ideas simply because they didn't have the chance to include them in the scope beforehand.
I know, I know. I just spent this entire article making a case for website design documentation. But it was actually Pinzon who delivered this shocker on our call: "Documentation, I think, is not always needed."
To be fair, he prefaced it with: "I guess this could be an important debate for the blog article."
So, let's debate it, then. Documentation clarifies design thinking, aligns stakeholders, saves time in the long run, and ensures the best website gets built. Why would it ever not be needed?
Pinzon pointed out two scenarios where you can ditch the documentation:
Unlike recipes, web design documentation can be more open to interpretation. After all, you can redo the code on a website; you can't unburn a turkey. But that doesn't mean you should leave developers guessing critical information.
Whipping up good design documentation takes time, but it's time well spent. Good documentation aligns teams, saves time in the long run, and ensures continuity no matter how long your web design project drags on or who joins or leaves the team.
For complex projects with multiple stakeholders, it's worth creating (and following) web design documentation - especially if you want your project to turn out just right.
77 Brilliant Examples of Homepages, Blogs & Landing Pages to Inspire You
All fields are required.