| 분류 | 항목 | 처리할 내용 | 이유 | 우선순위 | 반영 버전 | 처리 상태 | 메모 |
|---|
| 추가 | <대시보드와 위젯> | <대시보드로 모니터링>으로 타이틀 변경 | 사용자가 무엇을 할 수 있는지 파악 용이 | | 4.5.7 |
|
|
| <대시보드와 위젯>의 내용 | 대시보드로 모니터링 하기 위한 방법을 기술 상세 설명은 뒤에 '참고'로 변경 | 대시보드를 통해 모니터링 하려면 어떻게 해야하는지가 사용자에게 더 필요함 | | 4.5.8 | |
|
| 영문 매뉴얼의 쓰리래비츠화 | 번역한 영문 매뉴얼을 쓰리래비츠로 이관 작업 | 번역본 관리의 편의성과 효율성 향상 | | 4.5.8 | | 자동 기계 번역 활용 | API 가이드 | API 내용 및 사용 가이드를 <부록>에 추가 | SE의 작업 편의성 향상 | | 4.6.1 | 라이브러리 활용 | 매뉴얼 상단에 라이브러리 기능 추가 | 매뉴얼 사용할 때 편의성 향상 | | 미정 | 공통 UI 페이지 | 공통 UI를 설명하는 페이지 추가 | 중복 설명을 줄이고 누락된 설명 보완 | | 미정 | | Status |
|---|
| colour | Grey |
|---|
| title | 보류 |
|---|
최고관리자 계정 관리 | 최고관리자 계정(mcuser)이 잠긴 경우 해결 방법을 <부록>에 추가 | SE의 작업 편의성 향상 | | 4.6.1 | 수정
| 메인화면 목차 제목 변경 | '~메인 화면'을 '~모니터링'과 같이 사용자 액션 관점으로 제목 변경 고려 | 사용자가 무엇을 할 수 있는지 파악 용이 | | 4.5.8 | |
|
단계(step) | '요약+서술형'이 아닌 '서술형(+부연설명)'으로 통일 | 중복 제거와 일관성 향상 | | 4.5.7 | |
|
| 한 액션을 여러 단계로 쪼개지 않고 한 단계 안에 기술 | 간결성 향상으로 동작 절차 파악에 용이 | | 4.5.7 | |
|
| 장, 절의 도입문 | Who, What, Why와 같은 요소를 따라 기술 | 사용자가 원하는 내용에 접근성 향상 | | 4.5.8 | |
|
| 시스템 추가 시 입력 정보 | 콜아웃 리스트를 표로 정리 | 입력 정보 설명 스타일의 일관성 향상 | | 4.5.7 | |
|
| '화면에 진입' 용어 수정 | '진입' 이라는 용어가 적절하지 않아 동작을 기술하는 것으로 수정 | 정확한 의미 전달과 일관성 향상 | | 4.5.8 | | 화면 진입 → 화면 이동 |
| <워크플로우..> 입력 정보 | 그림보다 표로 입력값에 대해 설명 선택값에 대한 설명은 뒤에 '참고(기능)'로 변경 | 방법 절차나 입력 정보 파악에 있어 가독성 향상 | | 4.5.8 | |
|
| 팁, 참고, 주의 유형 지양 | 추가적인 정보가 필요하다면 내용에 넣고, 굳이 필요없다면 과감히 제거 | 문서 가독성과 변경 관리 효율성 향상 | | 4.5.8 | |
|
| 부록 | 추가 인증, 로그 확인의 내용 보완 | 동작(방법)에 대한 내용 부족 | | 4.5.8 | |
|
| '편집' 용어 개선 | 수정 기능에 사용된 '편집'을 '수정'으로 변경(영문 포함) | 정확한 의미 전달과 일관성 향상 | | 4.5.8 | |
|
| 마우스 우클릭 용어 변경 | '마우스 우클릭' 또는 '오른쪽 마우스 클릭'의 표현을 '마우스 오른쪽 버튼 클릭'으로 변경
'마우스 우 클릭'으로 통일 | '마우스 우 클릭'이 의미를 전달하는데 문제가 되지 않는다 판단 간결성, 일관성 향상 | | 4.5.7
4.5.8 | | 4.5.7에서 '마우스 오른쪽 버튼 클릭'으로 하였으나 간결하게 '마우스 우 클릭'으로 변경 |
| '알림'의 영문 번역 | Alarm으로 통일 | 국문처럼 알림의 의미가 더 정확하다고 판단(행아웃 참고) | | 4.5.8 | | RPO 내용 개선 | RPO 매뉴얼에 대한 사용자 동작 설명 보완 | 기능 사용 시 동작 설명 부족 | | 미정 |
|
| 제품 설치 방식 변경 | Docker 엔진 → podman 변경 | 설치 시 배포 도구 변경 | | 4.5.8.4 | UI(메뉴명, 버튼 등) 지칭 표기법 | <메뉴명>, [버튼], "UI 명칭" 등 지칭 시 가능한 Bold체로 표기 | 표기법 간소화로 가독성 향상 | | 4.6.0 |
|
| 지양할 표현 | '~ 다음과(아래와) 같습니다.'를 '(다음)~은 ~입니다.'와 같이 수정 | 습관적 표현 지양, 문장력 개선 | | 상시 | 습관적으로 사용된 '~을 통해'를 '~를 사용하여'와 같이 명확한 표현으로 수정 | 번역체 지양, 명확성 향상 | | 상시 | '~에 대해'를 '~을(를)'로 반결하게 수정 | 번역체 지양, 간결성 향상 | | 상시 | '~경우'를 '~하면'과 같이 수정 | 번역체 지양 | | 상시 | 제거 | 그림(캡쳐) | 동작 설명의 불필요한 그림은 제거 | 내용 축소와 가독성 향상 | | 4.5.7
상시 | | - 주요 기능별 메인화면 그림 첨부
- 내용 초입부만 캡쳐 시 메뉴 포함
→ 초입부는 접근 경로를 표시
→ 잦은 메뉴 변경에 의한 이미지 수정량 최소화 - 반복적인 내용 설명 시 중복 이미지 최소화
| 모호한 표현 | '등', '다양한', '정상적으로'와 같은 표현 지양 | 사용자에게 신속 정확한 내용 전달 | | 상시 | 불필요한 조사 및 표현 | '-의, -을, -적, -것, -들'과 같은 불필요한 조사나 표현 지양 | 문장의 간결성 향상 | | 상시 | '발생, 필요, 진행, 처리' 등 문장 내 군더더기 표현 제거 | 문장의 간결성 향상 |