Documentation Management for Your UX Project

• 5 min read

472 Shares

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:

AI for Designers

5 days
57 % booked
View Course

What You Should Read Next

  • Read full article
    8 Talks by Women to Inspire UX Designers - Article hero image
    Interaction Design Foundation logo

    8 Talks by Women to Inspire UX Designers

    User Experience design, like so many other disciplines, has a lower representation of women as compared to men. Things are changing now, though. Slowly, but surely. From strategy to tactics and from ideas to actionable tips, here is a curated playlist of talks by, and stories of just some of the mos

    Social shares
    655
    Published
    Read Article
  • Read full article
    UX Storyboards: Ultimate Guide - Article hero image
    Interaction Design Foundation logo

    UX Storyboards: Ultimate Guide

    In user experience design, we use techniques like workshops and interviews to understand users. We turn our research into user stories and process flows. We use personas and wireframes to share our ideas with our teams.But it’s important to remember the real people we design for. We need to know wha

    Social shares
    777
    Published
    Read Article
  • Read full article
    Stop the Generic Portfolio Trap! Design a Stand-Out Portfolio for Your UX/UI Niche: UX Writing - Article hero image
    Interaction Design Foundation logo

    Stop the Generic Portfolio Trap! Design a Stand-Out Portfolio for Your UX/UI Niche: UX Writing

    A picture may be worth a thousand words, but in UX design the right words are priceless. UX writing guides users, simplifies complex concepts, encourages desired actions, and creates a sense of delight. But how do you demonstrate you can do all of these things? How do you get noticed by hiring manag

    Social shares
    415
    Published
    Read Article
  • Read full article
    Mobile Breadcrumbs: 8 Best Practices in UX - Article hero image
    Interaction Design Foundation logo

    Mobile Breadcrumbs: 8 Best Practices in UX

    Breadcrumbs act as navigation aids—ones that simplify user journeys on websites. They highlight the path taken within a site to boost user experience, especially on mobile devices with limited screen space. Explore more about mobile breadcrumbs and understand the common design mistakes and best prac

    Social shares
    806
    Published
    Read Article
  • Read full article
    TAPT: Teasing Apart, Piecing Together - Article hero image
    Interaction Design Foundation logo

    TAPT: Teasing Apart, Piecing Together

    [[video:96]]Many experiences share the same core elements but differ in context. Photo sharing on Facebook has similar experience elements to sharing physical photos, but the actions involved and the context of the two experiences differ vastly. In creative processes, it’s valuable to analyze relate

    Social shares
    419
    Published
    Read Article
  • Read full article
    Why Care about Statistical Significance? - Article hero image
    Interaction Design Foundation logo

    Why Care about Statistical Significance?

    The categorical data depicts the success and failure rate of the low-fidelity wireframe above. There is not a large enough difference between the two to determine if the designs were successful.There is an element of error involved in measuring anything. So, when we want to compare measurements, how

    Social shares
    434
    Published
    Read Article
  • Read full article
    Web Fonts: Definition and 10 Recommendations - Article hero image
    Interaction Design Foundation logo

    Web Fonts: Definition and 10 Recommendations

    Web fonts bring digital content to life. They enhance readability, set the tone, and ensure consistency across various platforms—all vital ingredients. When you understand web fonts and their impact, it can help you with effective website creation—and greatly so. We’ll provide a comprehensive overvi

    Social shares
    782
    Published
    Read Article
  • Read full article
    How to Screen Research Participants - Article hero image
    Interaction Design Foundation logo

    How to Screen Research Participants

    Finding the right participants is crucial for gathering user research. We usually need to do research with participants having a particular set of needs or experience. In this short video, you will find out about the basic need for screening and how we make sure that we have suitably qualified parti

    Social shares
    452
    Published
    Read Article
  • Read full article
    Pitfalls in Recruiting Participants for User Research - Article hero image
    Interaction Design Foundation logo

    Pitfalls in Recruiting Participants for User Research

    The level of participant engagement is an important part of the user research results. Our results are dependent on proper engagement with our participants. In this video we look at some of the issues around participant recruitment and hear practical examples that arose in a large online study.[[vid

    Social shares
    421
    Published
    Read Article
  • Read full article
    How to Fit Quantitative Research into the Project Lifecycle - Article hero image
    Interaction Design Foundation logo

    How to Fit Quantitative Research into the Project Lifecycle

    Quantitative research methods fit into the project lifecycle at different stages of the process.In this video, we see where different quantitative research methods fit into a typical project lifecycle. Bear in mind that even with an iterative process such as Agile, the short cycles still address dif

    Social shares
    511
    Published
    Read Article

Top Articles

Top Topic Definitions

Feel Stuck?
Want Better Job Options?

AI is replacing jobs everywhere, yet design jobs are booming with a projected 45% job growth. With design skills, you can create products and services people love. More love means more impact and greater salary potential.

At IxDF, we help you from your first course to your next job, all in one place.

See How Design Skills Turn Into Job Options
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.

Feel stuck? Want Freedom?

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

Learn to design a life you love.

Next email in:
1
day
15
hrs
19
mins
40
secs