들어가며
최근 회사 업무를 진행하면서, 업무 중 발생한 파일을 관리하는 방법에 대해서 고민해보게 되었다. 온라인 업무를 진행하면 파일은 필연적으로 발생하게 되어 있다. 이것을 빠르고 정확하게 전달하며 관리하는 것은 오피스 업무ㄹ자에게는 꼭 필요한 능력이다. 나만의 파일 저장 패턴을 구축해보기로 한다.
현재 나의 상황
나의 상황은 개발자이며, 관리해야하는 파일은 기획자에게 넘어온 기획 문서, 디자이너에게 받은 디자인 문서, 개발자 분들이 나눠 공유하는 API 설계 문서 등이다. 이 문서들은 수시로 변하는 상황이 발생하며 이것을 트레킹 하면서 파일을 잘 관리하는 것이 관건이다.
최근 문서들은 사용자가 동시에 들어가서 편집 수정이 가능하다. 하지만 이것의 충돌이 일어날 수 있고 같이 수정하는 과정에서 기존의 기록들이 휘발되는 상황이 발생하기도 한다. 개인적으로 파일을 잘 관리하는 방법은 꼭 필요한 능력이다.
나만의 파일 명명 규칙
파일을 잘 관리하는 방법은 몇가지 방법이 있다고 생각했다.
- 나에게 전달된 문서는 보안에 문제가 되지 않으면 저장한다.
- 파일을 생성할 때 파일의 이름은 1번 정하면 수정하지 않는다.
- 파일에는 저장한 날짜가 필수적으로 들어간다.
- 파일에는 저장한 버전이 들어간다.
- 프로젝트마다 폴더를 나눈다.
- 파일은 1개만 따로 분리해도 사용자가 열기전에 내용을 알 수 있어야한다.
위의 내용을 고안해서 만들어낸 나의 명명 규칙은 이렇게 작명하기로 했다.
YYYY-MMDD_PROJECT_CATEGORY_FILENAME_VERSION.확장자
이렇게 정리하면 파일을 저장한 날짜와 버전을 바로 알 수 있을 뿐더러 어떤 프로젝트의 어떤 업무에서 사용하는 파일인지 바로 알 수 있어 편리 할것으로 예상한다. 폴더 정리도 프로젝트와 카테고리별로 정리하면 되니 아주 편리할 것이다. 한 동안 이렇게 정리해 사용해 보기로 한다.
파일 정리 예시
작명 규칙의 예시를 통해 빠르게 습득하고, 이해하는 시간을 가져 보았다.
2025-0423_GGOGIT_기획_기능정의서_V0_1.md2025-0424_GGOGIT_디자인_와이어프레임_V1_0.pdf2025-0425_GGOGIT_기술명세_API목록_V1_2.xlsx
폴더 카테고리
개발자가 만날 수 있는 폴더 카테고리는 아래와 같을 것으로 예상한다. gpt가 추천해준 폴더들은 아래와 같은데 모두 사용할 것 같지는 않다. 하지만 정리해 보기로 한다.
- 기획: 기능정의서, 요구사항 정의서, 스토리보드 등 초기 구상 문서
- 디자인: 와이어프레임, UI 시안, 프로토타입 등
- 회의록: 회의 요약, 액션 아이템 정리
- 기술 명세: API 명세, 시스템 아키텍처, 기술 스택 설명 등
- 개발: ERD, 코드 샘플, 설정 파일 설명 등
- 테스트: 테스트 케이스, 테스트 결과 정리
- 운영: 배포 매뉴얼, 운영 정책, 장애 대응 문서
- 매뉴얼: 사용자 매뉴얼, 관리자 가이드 등
- 이슈 정리: 버그 리포트, 이슈 로그, 해결 방법 등
- 버전 관리: 변경 이력, git전략, 릴리즈 노트 등
- 보안: 인증/인가 정책, 보안 이슈 대응 문서
- DB정의: 테이블 정의서, 인덱스 정의, 쿼리 최적화 노트 등
- 스크립트: 배포 스크립트, 초기화 스크립트 등
- 자동화: CI/CD 파이프라인 정의, 스크립트 설명서
- 회고: 프로젝트 회고, 개인 피드백, 기술 회고 등
- 자료조사: 참고 자료, 레퍼런스 모음, 벤치마킹 내용
- 프레젠테이션: 발표자료, 설명용 PPT
- 교육자료: 온보딩 문서, 개발자 교육 자료
- 라이센스: 소프트웨어 라이센스, 오픈소스 사용 규칙등
이 리스트 중에서 개발자가 자주 사용할 문서는 기획, 디자인, 개발, 운영, 테스트, 문서화 정도로 예상한다.
폴더 샘플 구조
위의 내용을 정리해서 나온 폴더구조를 작명해보면 아래와 같다.
project-root/
│
├── 01_기획/
│ ├── 요구사항정의서/
│ │ └── 2025-0423_GGOGIT_기획_요구사항정의서_V0_1.md
│ ├── 기능정의서/
│ │ └── 2025-0424_GGOGIT_기획_기능정의서_V0_2.md
│ └── 스토리보드/
│ └── 2025-0425_GGOGIT_기획_스토리보드_V0_1.pdf
│
├── 02_디자인/
│ ├── 와이어프레임/
│ │ └── 2025-0426_GGOGIT_디자인_메인화면_V1_0.pdf
│ ├── UI시안/
│ └── 아이콘시안/
│
├── 03_개발/
│ ├── ERD/
│ │ └── 2025-0427_GGOGIT_개발_ERD초안_V1_0.pptx
│ ├── 설정정의/
│ └── 코드샘플/
│
├── 04_기술명세/
│ ├── API명세/
│ │ └── 2025-0428_GGOGIT_기술명세_API목록_V1_1.md
│ ├── 시스템아키텍처/
│ └── 보안정의/
│
├── 05_테스트/
│ ├── 테스트케이스/
│ ├── 테스트결과/
│
├── 06_운영/
│ ├── 배포매뉴얼/
│ ├── 장애대응/
│
├── 07_회의록/
│ └── 2025-0429_GGOGIT_회의록_주간회의_V0_1.docx
│
├── 08_이슈정리/
│ ├── 버그리포트/
│ ├── 해결기록/
│
├── 09_교육자료/
│ ├── 온보딩/
│ └── 기술회고/
│
└── README.md
이런식으로 폴더의 구조가 그려진다. 이것은 개인적으로 프로젝트를 관리할 때는 아주 좋은 프로젝트로 판단된다. 앞으로 이렇게 프로젝트를 관리해 보기로 한다.
매일 반복되는 일상 속에서도 특별한 순간을 찾을 수 있기를 😊
Leave a comment