Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

작성일

2019.7.4(목) TW 교육 중

개선할 내용

MDRM v4.5.7~ 개선 사항은 다음과 같습니다.

분류항목처리할 내용이유우선순위반영 버전

처리 상태

처리 기준
메모
추가<대시보드와 위젯> 

<대시보드로 모니터링>으로 타이틀 변경

사용자가 무엇을 할 수 있는지 파악 용이
Status
colourRed
titleHIGH
4.5.7

Status
colourGreen
title완료


<대시보드와 위젯>의 내용

대시보드로 모니터링 하기 위한 방법을 기술

상세 설명은 뒤에 '참고'로 변경

대시보드를 통해 모니터링 하려면 어떻게 해야하는지가 사용자에게 더 필요함
Status
colourYellow
titleMEDIUM
4.5.8
Status
colourGreen
title완료

영문 매뉴얼의 쓰리래비츠화번역한 영문 매뉴얼을 쓰리래비츠로 이관 작업번역본 관리의 편의성과 효율성 향상
Status
colourYellow
titleMEDIUM
4.5.8
라이브러리 활용매뉴얼 상단에 라이브러리 기능 추가매뉴얼 사용할 때 편의성 향상
Status
colour
Blue
Green
title
LOW4.6
미처리
자동 기계 번역 활용
수정


메인화면 목차 제목 변경

'~메인 화면'을 '~모니터링'과 같이 사용자 액션 관점으로

변경하거나

제목 변경 고려

사용자가 무엇을 할 수 있는지 파악 용이
Status
colour
Red
Blue
title
HIGH
LOW
4.5.8
Status
colourGreen
title완료

단계(step)

'요약+서술형'이 아닌 '서술형(+부연설명)'으로 통일중복 제거와 일관성 향상
Status
colourRed
titleHIGH
4.5.
8
7
Status
colourGreen
title완료

한 액션을 여러 단계로 쪼개지 않고 한 단계 안에 기술간결성 향상으로 동작 절차 파악에 용이
Status
colourRed
titleHIGH
4.5.
8
7
Status
colourGreen
title완료

장, 절의 도입문Who, What, Why와 같은 요소를 따라 기술사용자가 원하는 내용에 접근성 향상
Status
colourRed
titleHIGH

4.5.8

Status
colourGreen
title완료

시스템 추가 시 입력 정보콜아웃 리스트를 표로 정리입력 정보 설명 스타일의 일관성 향상
Status
colourRed
titleHIGH
4.5.7
Status
colourGreen
title완료

'화면에 진입' 용어 수정'진입' 이라는 용어가 적절하지 않아 동작을 기술하는 것으로 수정정확한 의미 전달과 일관성 향상
Status
colourYellow
titleMEDIUM
4.5.8
Status
colourGreen
title완료
화면 진입 → 화면 이동
<워크플로우..> 입력 정보

그림보다 표로 입력값에 대해 설명

선택값에 대한 설명은 뒤에 '참고(기능)'로 변경

방법 절차나 입력 정보 파악에 있어 가독성 향상
Status
colourYellow
titleMEDIUM
4.5.8
Status
colourGreen
title완료

팁, 참고, 주의 유형 지양추가적인 정보가 필요하다면 내용에 넣고, 굳이 필요없다면 과감히 제거문서 가독성과
변경 관리 효율성
향상
Status
colourYellow
titleMEDIUM
4.5.8
Status
colourYellow
title상시

부록추가 인증, 로그 확인의 내용 보완동작(방법)에 대한 내용 부족
Status
colourYellow
titleMEDIUM
4.5.8
Status
colourGreen
title완료

'편집' 용어 개선수정 기능에 사용된 '편집'을 '수정'으로 변경(영문 포함)정확한 의미 전달과 일관성 향상
Status
colourBlue
titleLOW
4.5.8
'알림'의 영문 번역'alarm'을 'notification'으로 변경
Status
colourGreen
title완료

마우스 우클릭 용어 변경

'마우스 우클릭' 또는 '오른쪽 마우스 클릭'의 표현을 '마우스 오른쪽 버튼 클릭'으로 변경

'마우스 우 클릭'으로 통일

'마우스 우 클릭'이 의미를 전달하는데 문제가 되지 않는다 판단

간결성, 일관성 향상

Status
colourYellow
titleMEDIUM

4.5.7

4.5.8

Status
colourGreen
title완료
4.5.7에서 '마우스 오른쪽 버튼 클릭'으로 하였으나 간결하게 '마우스 우 클릭'으로 변경
'알림'의 영문 번역Alarm으로 통일국문처럼 알림의 의미가 더 정확하다고 판단(행아웃 참고)
Status
colourBlue
titleLOW
4.5.8
Status
colourGreen
title완료

제품 설치 방식 변경Docker 엔진  →  podman 변경설치 시 배포 도구 변경
Status
colourRed
titleHIGH
4.5.8.4
Status
colourGreen
title완료

제거그림(캡쳐)동작 설명의 불필요한 그림은 제거내용 축소와 가독성 향상
Status
colourRed
titleHIGH
4.5.
8
  • 주요 기능별 메인화면 포함
  • 반복적인 내용 설명 시 중복 이미지 최소화
모호한 표현'등', '다양한', '정상적으로'와 같은 표현 지양사용자에게 신속 정확한 내용 전달
7
상시

Status
colour

Blue

Yellow
title

LOW상시

상시

불필요한 조사 및 표현'-의, -을, -적, -것, -들'과 같은 불필요한 조사나 표현 지양문장의 간결성 향상
Status
colourBlue
titleLOW
  • 주요 기능별 메인화면 그림 첨부
  • 내용 초입부만 캡쳐 시 메뉴 포함
    → 초입부는 접근 경로를 표시
    → 잦은 메뉴 변경에 의한 이미지 수정량 최소화
  • 반복적인 내용 설명 시 중복 이미지 최소화