End-to-End Design Specs – Part XII: Inclusiveness
This is the final installment in a series I started almost a year ago. In the interim, I turned it into a talk that I gave at Interaction 16 called 10 Team Goals for Effective Design Specifications. The 10th goal is inclusiveness.
Certainly, you will be referencing your own specifications, but as in most things we design, we are not the sole user. Consider who else will be using your specs and what they’ll be using them for.
Developers are likely the heaviest users of your specs, so you need to understand how they use them. Do they print them out and have them laying on their desk while working? Do they view them on screen? Do they have to jump around in the spec, or is everything they need for a particular task on one page? What would they like to see included that isn’t in there now? What don’t they use?
Testers will use a specification to write test cases and evaluate the implemented product. How can you notify them of changes during development? Is there information you can include that will make automated test case maintenance easier?
Product Management may not need as great a level of detail as the developers, but they may rely on the spec as a record of what is making it into the next release. The spec is likely the best documentation they have of what is being implemented and how it works.
Sales & Marketing are always looking for material they can pull from to describe improvements in release notices.
Customers appreciate receiving a record of modifications made in a build.
Users can even benefit, if indirectly, as UI specs are great fodder for user guides and training materials.
Each of these stakeholders has different needs and will be using your documentation for different purposes. Some may be better off with custom variations on the standard specifications you deliver to developers.
In conclusion, remember that you aren’t creating documentation for its own sake. There are problems your documentation is solving. There are needs being fulfilled. Design documentation for its target audience.