| 수정 사항 | |
|---|---|
| 그림 목차와 표 목차 추가 | |
| 불필요한 이미지 줄이기 | |
| "특징 및 장점" 명확하지 않은 표현 수정 | |
| 노트 주의 참고 박스 설명 | |
| 순서에 결과가 들어가있는 부분 수정 | |
| 용어 설명 위로 빼기 | |
| "6 일반적인 장애" 내용 제목 정리하기 | |
| 2.1 메인화면 2.1.1 뒤에 없으니까 2.1.2가 없으면 목차에 내보내지말자 | |
| CLI는 부록으로 | |
| 스텝은 최대 8~9개 넘지 말아야한다. | |
| 구성방법에 이걸 구성해야하는지 설명 짧게 넣기 아니면 설명이 있는 곳 링크를 걸어준다. | |
이미지는 작게해서 한 화면에서 보이게 해야하고 단 어디한곳 꼭지점을 포함해야 유저가 위치를 파악할 수 있다. |
예시1: 소프트웨어 개발 키트(SDK) 가이드
예시2: 요구사항 분석서(SRS)
B2B 테크니컬 라이팅 이해하기
- B2B 테크니컬 라이팅 개념 및 중요성
- B2B 테크니컬 라이팅 절차
- 계획세우기
- 제목 정하기
- 주제(Subject)와 목적(Purpose)을 포함해야 한다.
- 특정 독자 분석하기
- 문서 작성 전 반드시 특정 독자를 분석
- 해당 기술지식 수준, 직급, 주요관심항목
- 기술 지식 수준이 높은 독자 + 기술 지식 수준이 낮은 독자
- 두개의 문서로 분류하여 연결
- 초급 독자 - Tutorial
- 고급 독자 - Advanced Developer Guide
- 구성으로 분류
- 개념(Concept)
- 동작(Task)
- 참고(Reference)
- 두개의 문서로 분류하여 연결
- 목차 작성하기
- 논리적으로 목차를 작성하되 최대 3수준(대제목, 중제목, 소제목)으로 구분하여 목차를 작성한다. → Level 4 이상은 지양
- 목차는 문서 작성자에게 지금 내가 어디에 있는지 알 수 있는 지도와 같은 것이다.
- 구성이란?
- 서두, 본문, 말미
- 본문 - 개념 동작 참고
- 좋은 구성이란?
- 개선되어야할 구성이란?
- 목차 퀴즈
- 제목 정하기
- 2초안 작성
- 수정
- 편집 및 교정
- 계획세우기
- B2B 테크니컬 라이팅 방법
- 실습
기술내용 종류 및 작성방법
- 프로시저(Procedure)
- 프로세스(Process)
- 분류(Classification)
- 구조(Structure)
- 정의(Definition)
효과적인 국문 기술내용 작성을 위한 가이드라인
- 단락 작성
- 문장 작성
- 예시
- 서두 - 특정 독자가 문서 전체를 이해하는데 필요한 기본적인 정보를 작성한다.
- 표지
- 개정이력
- 목차
- 그림리스트, 표 리스트
- 서문(문서목적, 문서 범위, 대상, 관련문서, 표기규약, 약어 및 용어정의)
- 본문 -
- 개념 - 특정 독자가 소프트웨어를 사용하거나 개발하는데 필요한 기본적인 정보를 작성한다.
- 소프트웨어 소개(Introduction)
- 사전 요구사항(Prerequisites)
- 개념 - 특정 독자가 소프트웨어를 사용하거나 개발하는데 필요한 기본적인 정보를 작성한다.
- 서두 - 특정 독자가 문서 전체를 이해하는데 필요한 기본적인 정보를 작성한다.
- 동작 - 동작에는 특정 독자가 소프트웨어를 사용하거나 개발하는데 필요한 순서정보를 작성한다
- 사용자 관점에서 동작 정보를 작성한다
- 동작 정보를 작성할 때 그 동작에 대한 이유를 작성한다.
- 소프트웨어의 기능이 아닌, 소프트웨어를 사용하기 위해 실제 사용자가 하는 동작을 작성한다.
- 예시 보여주기
- 동작 - 동작에는 특정 독자가 소프트웨어를 사용하거나 개발하는데 필요한 순서정보를 작성한다
- 참고(기능) - 특정 독자가 소프트웨어를 사용하거나 개발하는데 필요한 소프트웨어의 기능, 기술 정보, 상세요구사항, 품질특성을 작성한다.
- 말미 - 특정 독자가 본문을 이해하는데 필요한 부가적인 정보를 작성한다.
- 예를 들면 부록
- 수정하기
특정독자 위주의 기술내용 작성하기
SW 분야의 국, 영문 B2B 테크니컬 라이팅 교육
소프트웨어 개발키트(SDK) 가이드 실습
요구사항분석서(SRS) 실습