본문 바로가기

테크니컬 라이팅/WTD 컨퍼런스

WTD 호주 2024 - 복잡한 조직을 위한 네이밍 가이드라인 만들기

Jay Stephens는 CSIRO에서 2022년 7월부터 일했는데 그 경험을 공유합니다. CSIRO는 호주의 연방과학산업연구기구(Commonwealth Scientific and Industrial Research Organisation)라고 합니다(organization을 영국식으로는 organisation으로 표기합니다).

CSIRO은 꽤 규모가 큰 조직으로 각 조직, 팀, 프로젝트가 사일로화되고 서로 다른 문화, 기업 미션과 과학 미션이 혼합, 데이터 보존과 관련된 규정의 복잡성으로 인해 어려움에 직면했습니다. 이전에도 네이밍 규칙이 없었던 것은 아닙니다. 하지만, 지나치게 엄격한 규칙과 유연성 부족으로 인해 모호함과 규정 미준수로 이어져 실패했습니다.


과거의 실패와 현재의 상태를 분석한 후 브레인 스토밍을 거쳐 간단한 체크리스트, 원칙, 해야 할 일과 하지 말아야 할 일이 포함된 네이밍 가이드라인을 만들었습니다. 가이드라인은 지속적인 업데이트와 개선을 통해 살아있는 리소스가 되도록 설계했습니다. 엄격한 통제보다는 팀이 접근 가능하고 검색 가능한 리소스를 사용할 수 있도록 하는 데 중점을 두고 있습니다.

 

 

네이밍 규칙이 필요했던 이유 중 하나는 조직의 규모가 커지고 리소스가 많아지면서 장비마다 적절한 네이밍을 붙여줄 필요가 있었다고 합니다. 예를 들어 가상화 리소스가 늘어날 때 이에 대한 적절한 이름을 붙이지 않으면 나중에 다른 사용자가 어떤 리소스를 써야 하는지 모를 수 있다는 것이었지요. Q&A에서는 실제 운영 시에는 외부 공격 등을 방어하거나 아니면 임시로 사용할 리소스에 대해서는 의미 없는 이름을 붙여야 하는 경우도 있다고 이야기했는데~ 그런 피드백이 있었다고 합니다.

 

https://youtu.be/_ywFBzJpGNM?si=G6WqzkazRF8zkCHD

 

https://flic.kr/p/2qxnC8e

 

Write The Docs 2025 - Jay Stephens

 

www.flickr.com

 

728x90
반응형