개선할 내용
번역본 관리의 편의성과 효율성
영문 매뉴얼의 쓰리래비츠화 번역한 영문 매뉴얼을 쓰리래비츠로 이관 작업
Yellow자동 기계 번역 활용
MEDIUM 미정
내용 및 사용 가이드를 <부록>에 추가매뉴얼 사용할 때 편의성 향상
미정 라이브러리 활용 매뉴얼 상단에 라이브러리 기능 추가 공통 UI 페이지 공통 UI를 설명하는 페이지 추가 중복 설명을 줄이고 누락된 설명 보완
미정 Status colour Grey title 보류
LOW 미정
1
1
RPO 내용 개선 RPO 매뉴얼에 대한 사용자 동작 설명 보완 기능 사용 시 동작 설명 부족 Status colour Blue title LOW
미정
미정
지양할 표현
| 분류 | 항목 | 처리할 내용 | 이유 | 우선순위 | 반영 버전 | 처리 상태 | 메모 |
|---|---|---|---|---|---|---|---|
| 추가 |
| 설치 | 폐쇄망 환경에서 docker-compose 설치 방법 추가 | SE의 작업 편의성 향상 |
|
|
| 4.6.2 | ||||
| API 가이드 | API |
| 가이드 및 레퍼런스 문서화 | SE의 작업 편의성 향상 |
|
| Status | ||||
|---|---|---|---|---|
|
| 4.6.2 |
|
| ||||||||||
| 부록 | 최고관리자 계정(mcuser)이 잠긴 경우 해결 방법을 <부록>에 추가 | SE의 작업 편의성 향상 |
| 4.6. |
| 2 | ||||||||||
| 부록 | http와 https 간 전환 방법 추가 | SE의 작업 편의성 향상 |
| 4.6. |
| 2 | /wiki/spaces/VM/pages/708018209 | |||||||||||||||||||
| 라이브러리 활용 | 매뉴얼 상단에 라이브러리 기능 추가 | 매뉴얼 사용 편의성 향상 |
| 4.6.2 | ||||||||||||||||
| 공통 UI 페이지 | 공통 UI를 설명하는 페이지 추가 | 중복 설명을 줄이고 누락된 설명 보완 |
| 미정 |
| |||||||||||||||
| 영문 매뉴얼의 쓰리래비츠화 | 번역한 영문 매뉴얼을 쓰리래비츠로 이관 작업 | 번역본 관리의 편의성과 효율성 향상 |
| 미정 | 자동 기계 번역 활용 | |||||||||||||||
| 워크플로우 컴포넌트(실행명령) 종류 | 워크플로우 컴포넌트 설정(컴포넌트 추가)의 실행 명령(컴포넌트 종류)별 설명 추가 | 기본 제공되는 컴포넌트에 대한 이해도 향상 |
| 미정 | 작업량이 많아 중요한 것부터 작성하고 개선해도 좋을듯 | |||||||||||||||
| 수정 | 팁, 참고, 주의 유형 지양 | 추가적인 정보가 필요하다면 내용에 넣고, 굳이 필요없다면 과감히 제거 | 문서 가독성과 향상 |
| 4.5.8 |
|
| UI(메뉴명, 링크 등) 지칭 표기법 | <메뉴명>, "링크" 등 지칭 시 가능한 Bold체로 표기 | 표기법 간소화로 가독성 향상 기계 번역 시 따옴표 관련 문제 발생 |
|
| 4.6.2 | 버튼명은 쓰리래빗츠에서 별도의 문자 유형으로 서식 설정 |
| PDF 표제지 | 표제지 제작(디자인 요청) | PDF 문서 품질 향상 |
| 4.6.2 | 정은진 과장과 논의 | ||||||||||||||||||||||||
| RPO 내용 개선 | RPO 매뉴얼에 대한 사용자 동작 설명 보완 | 기능 사용 시 동작 설명 부족 |
| 미정 | |||||||||||||||||||||||||
| '~ 다음과(아래와) 같습니다.'를 '(다음)~은 ~입니다.'와 같이 수정 | 습관적 표현 지양, 문장력 개선 |
| 상시 |
| |||||||||||||||||||||||||
| 습관적으로 사용된 '~을 통해'를 '~를 사용하여'와 같이 명확한 표현으로 수정 | 번역체 지양, 명확성 향상 |
| 상시 | ||||||||||||||||||||||||||
| '~에 대해'를 '~을(를)'로 반결하게 수정 | 번역체 지양, 간결성 향상 |
| 상시 | ||||||||||||||||||||||||||
| '~경우'를 '~하면'과 같이 수정 | 번역체 지양 |
| 상시 | ||||||||||||||||||||||||||
| 제거 | 그림(캡쳐) | 동작 설명의 불필요한 그림은 제거 | 내용 축소와 가독성 향상 |
| 4.5.7 상시 |
|
| ||||||||||||||||||||||
| 모호한 표현 | '등', '다양한', '정상적으로'와 같은 표현 지양 | 사용자에게 신속 정확한 내용 전달 |
| 상시 | |||||||||||||||||||||||||
| 불필요한 조사 및 표현 | '-의, -을, -적, -것, -들'과 같은 불필요한 조사나 표현 지양 | 문장의 간결성 향상 |
| 상시 | |||||||||||||||||||||||||
| '발생, 필요, 진행, 처리' 등 문장 내 군더더기 표현 제거 | 문장의 간결성 향상 |