머스트 이름명명법

이 문서는 웹어플리케이션 개발시 이름명명에 관하여 정리한 문서입니다.

이름 명명법에관하여 여러가지 권고안이 있지만 의심의 여지가 많은 부분이므로, 머스트에서 연구하는 환경에 맞게 연구 경험을 토대로 폴더명, 문서명, 파일 이름 명명에 대한 지침을 정의하였습니다.

머스트 이름명명 설명서에는 폴더구조, 문서구조, 파일구조의 정보를 포함하고 있습니다. 구성원들간의 문서를 일관된 명명법 사용으로 문서관리 및 작업영역을 공유하여 접근 방법을 개선하여 개발과 문서관리를 위함을 목적으로 합니다.

1. 소개

머스트에서는 같은 내용의 콘텐츠일 경우 다른 파일명과 폴더명의 사용으로 시간손실과 내용의 애매성을 피하고자 폴더와 파일, 문서에 대한 일관된 명명 관행에 대한 필요성을 확인하여 지속적으로 문서 작업 환경 및 정보 관리를 위해 정보에 대한 액세스를 개선하는 데 사용하고자 이름 명명 규칙을 만들게 되었습니다.

해당 문서에 대한 검색 할 때는 수많은 방법이 있지만, 사용자들은 아직도 파일 구조를 통해 그들이 요구하는 문서를 찾는 탐색 경향이 있습니다.

머스트에서는 좋은 문서의 이름을 명명을 위해 다음의 요건을 충족시켜야 한다고 판단합니다.

접근과 검색을 용이하게 할 수 있는 이름이 되어야 합니다.
논리적 순서로 정렬되어야 합니다.
문서의 이름으로 사용자들이 쉽게 찾고 문서의 내용을 이해 할 수 있는 이름이 되어야 합니다.
문서파일일 경우 버전을 확인 할 수 있어야 합니다.

2. 이름 명명에 따른 구성요소

머스트에서는 기본적으로 폴더, 파일 이름 명명을 위해 다음과 같은 구성요소로 정의합니다.

필수 구성요소

Title

확장 구성요소

Version Number, Date, Author, Type

이름 명명에 따른 구성요소에 대한 속성을 정리
구분	형식	내용
Title	자유형식	직관적으로 알 수 있는 문서의 내용을 설명하는 제목을 사용하여 영문알파벳으로 표시하여야 한다. 대문자로 사용할 때는 첫문자열만 대문자로 사용하여야 한다.
Version Number	v1	여러 버전을 표시할 경우 v1, v1-1, v2, v2-1과 같이 -(빼기)로 구분하여 버전 정보를 표시한다. 팀 구성원은 문서의 동일한 버전을 변경하고 있는 경우, 팀 구성원 때 새 버전을 만드는 결정하여야 한다.
Date	yyyy-mm-dd	문서를 생성한 날짜를 “년-월-일”로 구분하여 표시 합니다. 구분자는 -(빼기)를 사용 하여야 한다.
Author	이름 또는 조직	저작자의 이름 또는 조직 표기. 영문알파벳 대소문자.
Type	오른쪽 형식에따른 영문알파벳 3자리대문자	문서 종류를 표시함으로써 제목의 길이를 줄일 수 있고 문서내용을 대략적으로 짐작 할 수 있습니다. 문서종류는 영문알파벳 3자리대문자로 표시하며 문서 형식에 따라 표시법은 아래와 같습니다.
		AGD : 비망록	AGR : 협정	ARS : 액션 요청
		BRN : 브리핑	CPA : 표지	CON : 계약
		DFT : 토론 초안	EXA : 샘플	FRM : 서식
		GRA : 허가	IDX : 색인자료	LTR : 서한
		LST : 목록	MAC : 매크로	Mstrong : 메모자료
		MIN : 의사록	MTG : 회의자료	NTS : 노트자료
		PLN : 계획서자료	PAP : 논문자료	POL : 정책자료
		PRS : 프레젠테이션자료	PRC : 진행상의 순서	RPT : 보고서
		SCH : 일정표	SPE : 연설문	SUM : 개요문서
		SUP : 보충자료

구분 기호

폴더명의 요소 구분기호는 .(점)으로 사용하며 문서 및 파일일 경우 요소 구분기호는 _ (언드바)를 사용하며, 동일요소에서의 구분는 -(빼기)를 사용하여 구분합니다.
예를 들어 “머스트 소개”와 같이 합성으로 구성될 경우
- 폴더명일 경우 “must.introduce” 로 .(점)을 사용하여 구분하고 영문알파벳 소문자로 표시하며
- 파일명일 경우 “must-introduce” 로 -(빼기)를 사용하여 구분하고 영문알파벳 대소문자로 이름을 정하여야 합니다.

약어

일관되게 사용되는 약어는 이름의 길이는 관리 유지할 수 있습니다. 약어는 표준화되지 않은 경우 단, 그들은 아주 시간의 경과 후에 해석이 어려울 수 있습니다. 허용되는 약어 목록은 각 조직이 개발해야합니다.
사업 단위에 대한 코드를 사용하는 경우, 코드의 일반적인 목록 또한 조직 내에서 일관성 있는 명명을 보장하기 위해 개발해야합니다.

3. 폴더명 명명법

폴더 이름은 해당 폴더내의 문서의 콘텐츠를 정의하는 정보가 포함하여야 합니다.

폴더는 여러 하위 폴더를 포함하고 있을수 있으며, 조합으로 구성된 요소, 이름 지정에 대한 약어등을 사용하므로 명명 결정에 주의가 필요합니다.

이름 길이는 255자 이하로 폴더내에 포함된 문서를 포함 할 수 있는 이름을 영문알파벳 소문자로 표시하고 구분기호는 .(점)으로 사용 하여야 합니다.

4. 문서파일 명명법

문서이름이나 파일명은 문서의 내용을 설명하기 위해 충분한 정보를 포함해야합니다. 이로 인해 사용자들이 신속하게 식별하여 정확한 정보 검색에 도움을 줄 수 있습니다.

어떤 경우에는, 폴더 구조가 일부 문서 이름의 포함 할 수 있으나 추후 다른 폴더로 이동이 되었을 때는 그 의미를 이해하기가 어려울 수 있으므로 머스트에서는 다음과 같이 규정합니다.

사용예

이름 명명 요소와 명명 규칙을 사용 하여, 다음과 같이 문서이름을 정할수 있습니다.
- Document Name_v2-1_2010-05-27_must_PLN.doc
- 위 파일명은 모두 5개의 구성요소(TITLE_VERSION_DATE_Author_Type)를 모두 포함 하고 있으며 의미를 해석하면 “Document Name(TITLE)의 문서는 머스트(Author)에서 만든 계획서(PLN) 버전 v2.1 (VERSION)으로 2010년05월27(DATE)에 생성된 문서”임을 파일명으로서 직관적으로 알 수 있습니다.

5. 이미지파일 명명법

웹에서 디자인 표현을 위한 웹 이미지일 경우에는 확장요소(Version Number, Date, Author, Type)를 생략하여 직관적으로 알 수 있는 타이틀만 표현합니다.
예를 들어 image01.png", "image02.png" 등과 같은 순차적인 이름을 가져 내용을 알수 없는 이름을 사용해서는 안되며 “must-log.png" 와 같이 내용을 포함한 타이틀이 되어야 합니다.
합성되는 이름일 경우 영문 알파벳 대소문자로 표시하며 구분자는 -(빼기)를 사용하여 구분합니다.

회사