Guideline: File Naming Structure

Download as pdf or txt
Download as pdf or txt
You are on page 1of 7

GUIDELINE

File Naming Structure

Version: rev00

Date: 2017-11-14

Author: Beate Lengsfeld

Department: Cross-Application Execution IC Standardization


Revision: Page:

00 2 (7)
Document Description:

[ID#] File Naming Structure

CONTENT
File Naming Structure ...............................................................................................................................3
1 General Rules ....................................................................................................................................3
1.1 File Naming in English ONLY ...................................................................................................3
1.2 No blank space .........................................................................................................................3
1.3 No special characters................................................................................................................3
1.3.1 permitted characters ....................................................................................................3
1.3.2 forbidden characters ....................................................................................................3
1.4 Remarks for the naming rules ...................................................................................................3
2 Content ...............................................................................................................................................4
2.1 Date - RECOMMENDED .........................................................................................................4
2.2 Detail – OBLIGATORY!.............................................................................................................4
2.3 Additional information as abbreviation – IF NECESSARY: ......................................................5
2.3.1 What?...........................................................................................................................5
2.3.2 Where? ........................................................................................................................5
2.3.3 Additional information: .................................................................................................5
2.3.4 Revision (Always at the end of the file name) .............................................................6
2.3.5 Who?............................................................................................................................6
3 Order of File naming content .............................................................................................................7
4 Area of Application .............................................................................................................................7

DOCUMENT HISTORY
Date Revision Change Author
2017.11.14 00 Draft adapted to Cross-App Board decisions BL
Revision: Page:

00 3 (7)
Document Description:

[ID#] File Naming Structure

FILE NAMING STRUCTURE


We want to follow some general rules in file naming to enable ourself and others to find our information quick
and clear.

1 GENERAL RULES

1.1 File Naming in English ONLY

As we are an international Company all file naming should be defined in English language to enable the
colleagues to find the information.

1.2 No blank space

Blanc spaces can be translated from some webserver into %20.


In case you want to create a link with the file name, very often the link breaks at the blanc space.

1.3 No special characters

1.3.1 permitted characters

a-z, A-Z, 0-9, “-“, “_”


All other characters are not recommended!

1.3.2 forbidden characters

Absolutly forbidden: . \ / : * ? " < > |


No local characters as é,è,ç,ø,æ,ô,ä,ö,ü,ß

1.4 Remarks for the naming rules

File format (ending as .docx etc will not be shown in this file naming rules, the ending is given by the software
anyway)
Revision: Page:

00 4 (7)
Document Description:

[ID#] File Naming Structure

2 CONTENT

The file name will consist of different parts.


The different parts of the file name will be devided by underscore character “_”.
That can be:

2.1 Date - RECOMMENDED

According to ISO 8601 the recommended date format could be


YYYYMMDD

If there is a date in the file naming structure, it will be always in the first position.

Remark:
Please avoid DATE and REVISION information in one file name.

2.2 Detail – OBLIGATORY!

This should describe the most significant content of the file.


The detail should NOT be abbreviated to give a chance to find the file with a seach function and to have an idea
of the content even years later.

The Detail should be as short as possible!


If the Detail consists of more than one word, the beginning of a new word is shown with a capital letter.

Examples:
Agenda
SiteSupervisor

Remark:
The Detail could also content a project number if the file is part of a project.
Revision: Page:

00 5 (7)
Document Description:

[ID#] File Naming Structure

2.3 Additional information as abbreviation – IF NECESSARY:

The additional information will be devided by underscore character “_”.


The abbreviations should be as short as possible, but as long as necessary.
An open list of abbreviations will be attached to this document.

2.3.1 What?

Examples:
JD = JobDescription
GL = Guideline
BR = BusinessReview

2.3.2 Where?

Examples:
Global
NAM
LAM
EMEAN
EMEAS
APACxC

2.3.3 Additional information:

For what ever reasons, addidtional information could be necessary:


Examples:
CC = Sub type of document (HS: Hardware Specification belongs TS type)
DD = Sequential
XX = A0…A4 paper format
Revision: Page:

00 6 (7)
Document Description:

[ID#] File Naming Structure

2.3.4 Revision (Always at the end of the file name)

Examples:
rev00 = revision 0 (The number should have always min 2 digits)

2.3.5 Who?

Who? means who is creator/owner of this document.


If a document has an owner, this information is the only thing that can stand behind a revision number

Examples:
KB = Kristina Boee
Revision: Page:

00 7 (7)
Document Description:

[ID#] File Naming Structure

3 ORDER OF FILE NAMING CONTENT

The File Naming starts with the detail or if this is important with the date in the agreed format.
This has the advantage that you can see the most important information of the file name even if the name will
not be fully shown e.g. if the column is not wide enough.
After the detail additional information could be given in abbreviated format

Please follow this order:


YYYYMMDD(recommended)_Detail(obligatory)_What_Where_Additionals_rev_Who.xxx

Examples:
YYYYMMDD_Detail_AB_CD.xxx
20171114_FileNaming_GL_draft_BL.docx
FileNaming_GL_rev00.docx

4 AREA OF APPLICATION

This Guideline was developed for the Sharepoint collaboration site of Cross-Application Execution (to support
change into a Meta data structure instead of folder structure).

You might also like