매뉴얼의 요건
CODEDRAGON ㆍDevelopment/Software Engineering
반응형
매뉴얼의 요건
요건 | 설명 |
적합성 | · 사용자의 관점에서 사용목적에 맞는 정보에 초점을 맞추어 정리 · 실무자용도: 아주 상세하고 구체적으로 설명 · 관리자용도: 핵심위주로 요약 설명 |
평이성 | · 기초지식이나 경험이 없는 제3자가 읽거나 보더라도 이해하기 쉽도록 정확한 단어와 간결한 문장을 사용 |
정확성 | · 사용자의 관점에서 사용목적에 맞는 정보에 초점을 맞추어 전달 · 단순한 사실 중심이 아니라 사실에 대한 분석을 토대로 일반화할 수 있는 요소들을 추출하여 제시 |
일관성 | · 내용적으로나 형식적으로 일관된 흐름에 따라 기술해야 함 · 내용적 흐름: 업무추진 절차나 과정별로 정리 · 형식적 흐름: 글씨크기, 모양, 도표 등을 일정하게 사용 |
검색성 | · 목차, 개요 등을 활용, 사용자가 쉽게 필요한 것을 찾을 수 있도록 배려 |
해결법 | · 실제 추진 과정에서 겪었던 장애요인 및 극복 방법을 솔직하게 핵심적 요인 중심으로 정리 · 매뉴얼은 벤치마킹을 위한 좋은 자료, 공통적으로 겪을 수 있는 문제에 대해 앞선자의 노하우 제공 |
사례 | · 실제 적용 상황이나 사례 제시를 통해 사용자의 이해를 도움 |
비주얼 | · 텍스트를 줄이는 대신 그림 등을 가능한 곳마다 사용 |
'Development > Software Engineering' 카테고리의 다른 글
Stackoverflow - Developer Survey Results 2018 (0) | 2018.12.23 |
---|---|
SUMMARY - 소프트웨어 모듈화, 소프트웨어의 모듈 및 패키징, 제품 소프트웨어 패키징의 개요, 패키징에서의 릴리즈 노트의 파악, 패키징 도구를 활용한 설치, 배포 수행하기 (0) | 2018.12.16 |
크로스 컴파일러(cross compiler) (0) | 2018.12.07 |
EXPLAIN PLAN 활용 - Explain Plan 준비, Explain Plan 실행, EXPLAIN PLAN & Autotrace 결과 화면(예시) (0) | 2018.12.04 |
API(Application Programing Interface), 웹 API (Web API) (0) | 2018.12.02 |