Type writer

Naming conventions for project documentation

Standardised naming conventions are really useful for your documentation on a project. They provide a framework and standard for defining documents.

They also make it easier to know at a glance which client or department and project the document relates to, as well as which information is likely to be contained in the document.

Here are my top tips for useful and descriptive naming conventions.

What to include

Include useful information in the file name, such as

  1. Client
  2. Project
  3. Document
  4. Version

Use a hyphen to separate each section. Capitalise each new word to support legibility of phrases without spacing.

Example: [Client]-[Project]-[Document]-[Version]
Example: Ikea-WebsiteRedesign-FunctionalSpec-v0.1

This naming convention can be used for all shared project documents, both internal and client facing.

For longer file names

When you have a long project name, try shortening this to the key notable elements while keeping the project identifiable. E.g. if your project name is ‘Changes to the gift membership templates’ amend this to ‘GiftMembershipAmends’

For internal documents

For internal documents which are not related to a specific project, look to include the following:

  1. Department/team/discipline
  2. Document
  3. Version

Example: [Department/Team/Discipline]-[Document]-[Version]
Example: LeadershipTeam-FinancialReviewMinutes2017Q4-v2.0, or
Example: VisualDesign-WorkshopTemplate-v0.1

Leave a Reply

Your email address will not be published. Required fields are marked *