Person carrying a yellow document case labeled MY DOCUMENT

Documentation Management for Your UX Project

• 5 min read

483 Shares
Save

Documentation management is the bane of many a project manager’s existence. Yet, without a clear and simple documentation management system projects often go astray. Your team members need to be able to find their documentation when they need it. If they can’t; they’ll go and do other things instead or waste hours of time trying to find it. Neither of these things is good for the health of your UX project. So let’s look at some simple tips for better document management on UX projects:

Keep All Documents in One Place

The simplest part of documentation management is keeping all your documents in one place. Physical documents should be kept in a filing cabinet with a sign-in, sign-out control. The filing cabinet should be reasonably well-ordered to minimize the hassle of finding things too.



Author/Copyright holder: Quinn Dombrowski. Copyright terms and licence: CC BY-SA 2.0

Ideally, you’ll have a documentation management tool for electronic documents but we’ve worked in enough places (even massive organizations) where this is not a priority for the IT budget and you have to do the hard work yourself. So create a space on your network for all project files and ensure they’re kept there – you can always add access controls for sensitive documents, etc.

Come Up With a Naming Convention


Author/Copyright holder: Scott Adams. Copyright terms and licence: All rights reserved Img source

There are plenty of off-the-shelf naming conventions; the key really is to adopt a naming convention that is meaningful to everyone on the project. You may want to canvass people’s opinions on what will work best in your environment. If you’re really lucky… the company will already have a standardized naming convention that you can use – but again we wouldn’t count on it. In our experience, documentation management is all too often neglected.

Naming should indicate:

  • The owner of the document
  • When it was created
  • What the purpose of the document is – this can’t be stressed enough, numerical naming conventions sound good in theory but they make finding what you want next to impossible
  • What version of the document this is – there’s nothing more frustrating than finding you’ve just put a week’s work into doing something based on an expired version of a document

Create a Filing System to Support the Naming Convention


Author/Copyright holder: Google Inc.. Copyright terms and licence: All rights reserved Img source

Chucking all the project files into a single folder can create chaos. Come up with a meaningful filing system for documents that allows people to know where they should head to get the information they need. By all means restrict access to certain areas based on need-to-know but try not to be too controlling; it’s better to let people have easy access to information if it’s not commercially sensitive than it is to deal with a million exception requests from project members who can’t access what they need to get the job done.

Support the Use of Your Conventions

If you’re introducing documentation management for the first time… people are going to make mistakes, they’ll fall back on old habits, etc. unless you help them not to. Spring clean the document areas occasionally and send stuff back to the originator if it doesn’t meet the standards. Very soon your documents will be much easier to find.

Header Image: Author/Copyright holder: Unknown. Copyright terms and licence: Unknown. Img


Learn More in This Course:

Learn Design and AI From the Best

Get one powerful email each week, like 312,441 others.

Next email in:

What You Should Read Next

  • Read full article
    Turn Your Non-Design Experience into Design Portfolio Gold - Article hero image

    Turn Your Non-Design Experience into Design Portfolio Gold

    Have you ever wondered how to transition into UX and product design from a different career background without feeling insecure? Let's uncover strategies to confidently bridge the gap and showcase your skills to prospective employers with confidence and clarity.In this video, Morgane Peng, Desi

    Social shares
    507
    Published
    Read Article
  • Read full article
    Structure First: The Inverted Pyramid and Visual Organization - Article hero image

    Structure First: The Inverted Pyramid and Visual Organization

    This clip examines two principles that work hand in hand to make web content readable: the inverted pyramid approach to information order and the use of visual structure to help users scan efficiently. William Hudson, UX Strategist and Founder of Syntagm Ltd, describes the theoretical basis and prac

    Social shares
    205
    Published
    Read Article
  • Read full article
    What Is Card Sorting? - Article hero image

    What Is Card Sorting?

    In this video, William Hudson, UX Strategist and Founder of Syntagm Ltd, introduces card sorting: what it is, where it comes from, and the broad range of problems it can help solve.Card sorting is a research technique in which participants organize a set of items into groups that make sense to them,

    Social shares
    171
    Published
    Read Article
  • Read full article
    Design Accessible Navigation for Keyboards and Screen Readers - Article hero image

    Design Accessible Navigation for Keyboards and Screen Readers

    Accessibility is often treated as a finishing touch, but for navigation, it belongs at the foundation. Menus are how users reach everything else on a site, so a menu that works only with a mouse quietly shuts out anyone who depends on a keyboard, a screen reader, or another form of assistive technol

    Social shares
    172
    Published
    Read Article
  • Read full article
    The Scent of Information: Give Users the Confidence to Click - Article hero image

    The Scent of Information: Give Users the Confidence to Click

    William Hudson, UX Strategist and Founder of Syntagm Ltd, introduces the scent of information as a model for understanding how users navigate toward their goals, and sets out the principles for writing navigation links that strengthen that scent.Information Foraging and the Scent of InformationThe s

    Social shares
    171
    Published
    Read Article
  • Read full article
    4 UI Design Tips Every Designer Needs to Know - Article hero image

    4 UI Design Tips Every Designer Needs to Know

    User interface (UI) design can make or break any digital product. A user often won’t even notice when they interact with a great UI. They feel the visual appeal and simply trust it. On the contrary, a bad UI design can prevent the user from interacting with a product intuitively or at all and lead t

    Social shares
    646
    Published
    Read Article
  • Read full article
    How to Design Use Cases in UX - Article hero image

    How to Design Use Cases in UX

    Imagine a new mobile app or an e-commerce site gets launched; it looks great, sure, and it should be a hit because it at least looks like it’s got what it takes, but—drumroll—it tanks in the marketplace, all because people find it hard to complete even the simplest tasks. That’s rough, but—behind th

    Social shares
    804
    Published
    Read Article
  • Read full article
    How to Become a Product Manager: Best Career Advice - Article hero image

    How to Become a Product Manager: Best Career Advice

    Pick any product and you’ll find that product management is vital to how successful it is—and product managers are who make sure that a product’s life cycle runs smoothly, and it means they know how to align strategy, vision, and user needs. Product managers split into multiple roles that have got u

    Social shares
    603
    Published
    Read Article
  • Read full article
    Bad UX Exposed: A Comprehensive Guide to Avoiding Pitfalls - Article hero image

    Bad UX Exposed: A Comprehensive Guide to Avoiding Pitfalls

    In today’s vibrant digital design landscape, creating meaningful connections with users goes beyond offering innovative products or services. It leads us into the world of user experience design (or UX design). This critical factor shapes our interaction with the users and plays a big role in making

    Social shares
    975
    Published
    Read Article
  • Read full article
    Understand the Various Types of Creativity - Article hero image

    Understand the Various Types of Creativity

    When you want to be more creative, you’ll want to learn the techniques for creative thinking and understand the various forms of creativity and creative processes. This video will give you an overview of some of the different forms of creativity. For example, you’ll learn that there are two types of

    Social shares
    578
    Published
    Read Article

Top Articles

Top Topic Definitions

39% of Today's Skills Will Change by 2030

The World Economic Forum expects 39% of today's skills to be transformed or become outdated by 2030.

The good news is that jobs in UX / UI design and AI are among the fastest-growing professions globally.

Build Skills That Keep You Relevant

Privacy Settings

By using this site, you accept our Cookie Policy and Terms of Use.
Customize
Accept all

Be the One Who Inspires

People remember who shares great ideas.

Share on:

Academic Credibility — On Autopilot

Don't waste time googling citation formats. Just copy, paste and look legit in seconds.

Learn Design and AI From the Best

Get one powerful email each week, like 312,441 others.

Next email in: