멘토 : 김준범 (SK 주식회사)
[ 2021. 06. 10 ]
결론
- Technical Writing 원칙을 숙지!
- 좋은 Reference 자료 확보/분석
- 많이 작성!
Technical Writing 의미
수학,과학,공학 내용을 전달하기 위해 사용하는 문서 작성 총제
수학 vs 과학 : 자연계 실체 여부
과학 vs 공학 : 경제성 관점 적용 여부
공학 : 비용 대비 최대의 이윤 산출이 목표
필요성
- 효율적 지식전달
- 상대방 설득에 필수적
- 개인 가치 상승 주요 수단 : 개인 PR / 몸값 상승
Technical Writing은 매우 기본적인 역량이다
개인의 역량을 세분화 한다면
4. ICT 활용 역량 : 전반적 관점의 문제 해결(BIZ/TECH연관을 고려한 적용)
3. ICT 지식 역량 : 알고리즘, 언어, New Tech
2. 이공계 기본역량 : 수학, 과학, 공학
1. 업무 기초역량 : 집중력, 끈기, Logical Thinking, Technical Writing
4원칙
-
내/외 환경 고려
문서를 작성하는 목적, 문서를 통해 얻고자 하는 바, 독자(독자 환경)파악
ex) 사장이 매출 총액이 얼마냐 ?
-> 200억입니다. 세부 항목은 ... (GOOD)
-> 1번 항목은 얼마, 2번 항목은 얼마 ....... 총 200억입니다 (BAD)
청자가 원하는 것을 말하는 것이 중요함! (사장이 원한것은 총액!) -
논리적 흐름 고려
내용 선택 / 체계화, 적절한 분량, 피라미드 구성, 적절한 작성 (맞춤법, 주어 부재 방지, 맺음말), 지루하지 않게 작성
- 시각적 상황 고려 : 도식, 도표 -> 이해도 증진
시각적 접근성 고려(들여쓰기, 줄바꿈), Object(사진, 도표, 차트, 아이콘),
일관성 유지 - 42이노베이션-> 연수 -> 42서울 -> 교육 ...(X): 한단어로 통일 - 윤리적 기반 고려 : 불리한 데이터 숨기지 말것, 거짓 암시 주의, 표절/거짓말 금지, 출처, 최대한 증빙
목차 작성
논리의 기술 (바바라민트)
- 목차 작성시 어떤 계층에 있는 항목은 하위 그룹의 항목을 요약
- 그룹내에서는 항상 동일한 유형을 유지 (속성이 동일한 것들끼리 구성)
- 하위 그룹은 3-4개
- 이해는 항상 첫번째 목적! : Top down 방식
- 귀납적 전개 (= 두괄식 표현) : 반전 최소화
cf. 귀납적 전개(상위개념을 하위 개념으로 등분) vs 연역적(순차적) 전개 - low depth 표현도 좋은 수단 : detail
(kiling point 노출은 필수, 문맥상/분량상 구체적이고 생생한 내용기재)
요약
- why : 해당 기술 등장 배경, 과거 트랜드
- what (object 중심) : 개요,개념,정의,특징
구성도(중요), 프로세스 / 유형, 종류 - how : 구현 과정 관련 사항(일정, 방법, 조작), 긍정적/부정적 기대효과
순서도 및 기호 사용
도표 작성
제목은 중앙 정렬, 텍스트는 왼쪽 정렬, 숫자는 오른쪽 정렬, 숫자 1000단위 ',' 넣어주기
문서 작성 프로세스
아이디어 구상 : 서비스 구상도
기획 : 기획서, 요구사항 정의서, 기능 정의서
개발 진행: UI WireFrame
- 서비스 구성도 : 전체 도식도
- 개발하고자 하는 시스템을 가운데에 위치하고 boundary 설정
- 내부 - 주요 object, communication, process 표시
- 외부 - 주요 actor, 내외 interface
- 서비스 시작 : 좌측 상단, 종료 : 우측 하단
object , actor 등이 같은 경우 동일 위치에 표시
주요 데이터 항목등은 프로세스에 추가 표시
작성하고자 하는 시스템 전체 바운더리를 기준으로 내외
- (요구사항 정의서) : 출처, ID, 제목, 설명, 기능여부(기능/비기능)등을 포함
외주 작업시 활용 - Menu Tree : Pyramid Structure, balanced MECE 구조
- UI WireFrame : 실제 화면 구성
- System Architecture: 서비스 구성도를 SW 기술/개발 관점에서 업그레이드 한것. 채택/구성 사유가 중요
