최종 사용자 명명법이 변경 될 때 코드와 데이터의 이름을 얼마나 바꾸어야합니까?

오래 전에 워크 플로 대기열에 이미지를 추가 한 후 사용자가 이미지를 "수락"할 수있는 기능을 추가했습니다. 우리는 잘못된 용어를 사용했으며 사용자는 실제로 이미지를 "승인"했습니다.

인터페이스에서 승인 승인을 변경하는 것은 쉽습니다. 한 단어 만 바꾸면됩니다. 그러나 CSS 클래스 이름에서 데이터베이스 값에 이르기까지 "accept"라는 단어로 모든 레이어를 프로그래밍했습니다.

• 버튼을 녹색으로 바꾸는 CSS 클래스 : ".accepted";
• DOM 노드에서 클래스 속성을 확인하고 바인딩하는 모델 메소드 : "isAccepted";
• JavaScript 상태 속성 : "검토되지 않음", "수락 됨"및 "게시 됨"인 배열.
• MySQL 상태 열 : "검토되지 않음", "수락 됨"및 "게시 됨"이있는 ENUM;
• 시험 명;

대부분의 승인 승인을 대체하는 것은 사소한 일입니다 (특히 테스트가있을 때). 특히 배포와 동기화해야하기 때문에 데이터를 마이그레이션하는 것이 조금 더 어렵습니다.

이 특정 사례는 간단하지만 경력 기간 동안 비슷하지만 더 복잡한 사례에 직면했습니다. 파일 이름이 바뀌고 수십 대의 서버에서 배포가 발생하거나 프록시 캐싱, memcached 및 mysql이 관련된 경우.

인터페이스를 제외한 다른 모든 계층에 "수락"을 남겨 두는 것은 좋지 않은 생각입니다. 팀에 합류하는 새로운 프로그래머는이 결정을 이끌어 낸 역사적 이유를 알지 못할 수 있습니다. 수락-> 승인하는 경우 의미 측면에서 가까운 단어입니다. "관리 다음 상태 회의를 위해 대기 중"으로 이름이 바뀌 었습니다. 그리고 우리가 여기 저기 타협하면 몇 번의 반복으로 사용자 인터페이스 개념이 시스템 내부와 아무런 관련이 없으며 출력의 절반이 내부와 연결되어 있지 않은 시스템에서 작업하고 싶지 않습니다.

따라서 필요할 때 항상 모든 이름을 변경합니까? 이것이 당신에게 일어 났고, 당신이 그 절충이 가치가 없다고 결정했다면, 그것은 당신을 물기 위해 다시 왔습니까? 코드 주석 또는 개발자 문서가이 문제를 피하기에 충분합니까?

나를 위해, 해당 항목과 관련된 모든 것을 변경하는 것이 가장 좋습니다.

이는 코드 저하의 한 형태이며, 변경되지 않은 1 개의 항목은 큰 문제는 아니지만 코드베이스의 톤을 설정합니다.

또한 향후 혼란을 초래할 수 있으며 새로운 개발자가 코드 기반 / 도메인을 이해하기 어렵게 만들 수 있습니다.

질문 내용과 태그에서 유비쿼터스 언어를 사용한다고 가정합니다.

내 경험상 UL은 훌륭하지만 언급했듯이 언어가 발전함에 따라 추가 유지 관리 작업이 발생할 수 있습니다. 이것은 그 자체로 나쁜 것이 아닙니다. 물론, 불편하지만, 또한 예상됩니다.

내가 일반적으로 한 일은 다음 중 하나입니다.

• 1 회성 사전 리팩토링 : 업데이트 된 언어를 채택하도록 애플리케이션의 모든 계층을 리팩터링하십시오. 또는
• 기술적 부채 기록 : 사용자가 직면 한 코드를 즉시 변경 한 다음 기술적 부채 과제를 기록하여 나머지 응용 프로그램 계층을 업데이트 된 언어와 일치시킬 수 있습니다. 이로 인해 일반적으로 몇 가지 지루하지만 관리 가능한 작업이 발생합니다. (오후 5시 완벽!)

여기서 중요한 것은 기술하려는 부채 가 기술 부채 라는 점입니다.

나는 눈에 띄는 기능을 추가하지 않는 사소한 작업에 시간을 낭비해서는 안된다고 주장한 관리자가 있습니다. 이것은 부채 비유가 실제로 유용 할 때입니다. 이것으로 요약됩니다.

팀은 유비쿼터스 언어로 DDD를 선택했습니다. 코드를 일관성이없는 상태로 두어이 접근 방식에서 벗어나면 혼란이 가중되고 DDD 및 UL이 제공하는 많은 이점이 제거됩니다. 관리자 측면에서 프로젝트에 비용이 추가됩니다. 코드는 관리하기가 어렵고 (비싸고) 새로운 개발자에게는 비용이 많이 듭니다 (비싸다).

현지화 (l10n) 옵션을 살펴볼 수 있습니다. 영어에서 스페인어로가는 것만 큼 과감 해 보이지는 않지만 같은 개념에 대해 다른 용어를 다루고 있습니다. 이것이 일반적으로 발생하는 경우 l10n을 사용하면 코드에 사용 된 용어를 변경하지 않고도 사용자 인터페이스에 표시되는 내용을 빠르게 변경할 수 있습니다.

그 자리에서 가장 널리 이해되는 코드의 용어를 사용하십시오. 개발자가 알고 예상 할 수있는 도메인 이름을 선택하십시오.

이를 적절하게 묘사 할 때 소스의 모든 부분에서 최종 사용자 명명법 변경을 추적하는 것은 상당한 투자입니다. 그러나 완전한 인프라 (핫라인, 테스터 등)로 개발 된 장수명 제품의 경우 특히 가치가 있습니다.

소스에서 최종 사용자 명명법을 추적하는 것은 투자 대상입니다. 구성 요소 유형이 너무 많고 이러한 모든 구성 요소에 동시에 작동하는 마술 지팡이가 없기 때문입니다. 어쩌면 구성 요소 다음에 그러한 마술 지팡이를 개발하는 것은 프로젝트의 수명 기간 동안 희석 할 수있는 흥미로운 투자 일 것입니다.

나는 최종 사용자 명명법과 내부 명명법 사이의 편차가 특히 커지는 30 년 된 코드베이스에서 일했습니다. 이 상황의 몇 가지 단점은 다음과 같습니다.

1. 적절한 정책이 없다면, 새로운 개발은 현재 최종 사용자 명명법을 사용하는 경향이 있습니다. 따라서, 동일한 개념은 다른 구성 요소에서 둘 이상의 이름을 가질 수 있습니다. 구성 요소가 서로 상호 작용하기 때문에 코드의 일부 로컬 부분에 여러 동의어 이름이 시뮬레이션으로 존재합니다.

2. 핫라인 / 헬프 데스크가 호출되면 최종 사용자 명명법을 사용하여 사용자 스토리를 작성합니다. 문제 해결을 담당하는 개발자는 최종 사용자 명명법을 소스 명명법과 일치하도록 번역해야합니다. 물론 그것은 보관되지 않으며 물론 엉망입니다. (1 참조)

3. 프로그래머가 코드를 디버깅 할 때 관련 함수에서 중단 점을 설정하려고합니다. 최종 사용자 명명법과 소스 명명법이 일치하지 않으면 적절한 기능을 찾기가 어렵습니다. 관련 기능의 목록이 완성되었다고 확신하는 것은 어렵거나 불가능할 수도 있습니다. (1 참조)

4. 적절한 정책이 없으면 구식 명칭을 사용하는 소스의 유지 관리는 때때로이 구식 명칭을 다시 사용자 앞에 놓을 것입니다. 이로 인해 인상이 나 빠지고 오버 헤드가 발생합니다.

데이터베이스에서 일부 데이터를 읽고이 코드베이스의 일부 구성 요소에 삽입하는 장소를 이틀 동안 추적했습니다. 내가 근무했던 회사의 어느 누구도이 장소로 이어지는 이름을 알 수 있었기 때문에 마침내 그 문제를 해결하고 다른 해결책을 찾기로 결심했습니다.

아무 것도 (지식이없고, 수정이없고) 아무것도 산출하지 않고 2 일 이상의 유지 보수 비용이 들지만, 사용자 명명법과 소스 명명법 간의 불일치가 많은 일상적인 작업에 오버 헤드를 가중시킵니다. 소프트웨어.

소프트웨어를 생산하는 회사에서 오버 헤드 비용이 증가한다는 점을 언급하는 것이 중요합니다. 대규모 조직에서는 여러 동료가 고려하기 전에 문제 보고서가 책상에 도착하지 않으며 수정이 테스트 될 수 있습니다.

[1] 둘 이상의 개발자가 참여했기 때문입니다.

일부 패키지는 고객간에 공유되므로 항상 코드와 데이터의 이름을 바꾸지는 않습니다. 그들은 기본적으로 같은 것을 사용하지만 다르게 호출합니다. 예를 들어 CMS에서 한 클라이언트는 고객을 "고객"이라고하고 다른 클라이언트는 "클라이언트"를 사용합니다. 따라서 고객 한 명을 대신하여 고객을 고객으로 교체했지만 CMS는 항상 고객 관리 시스템입니다.

또 다른 예는 권한 대 액세스 제어 목록, 관리자 대 관리자 등의 용어를 사용하는 사용자 관리입니다. 새 커머에게는 혼동 될 수 있지만 이와 같은 핵심 구성 요소의 경우 해당 구성 요소가 모든 클라이언트 및 또한 다른 개발자가 쉽게 구현할 수 있습니다 (예 : 구성 가능한 레이블 작성).

이 변경을 수행하면 다른 고객이 동일한 제품을 사용하여 기본적으로 제품으로 바꾸는 경우 다시 변경할 필요가 없다고 생각하는 것이 도움이 될 수 있습니다.