"한빛N MSA"의 두 판 사이의 차이
라이언의 꿀팁백과
(새 문서: = 세미나 정보 = - 일시 : 2023년 11월 9일 7:45 ~ 9:00 - 장소 : 한빛미디어 (서울 서대문구 연희로2길 62) A동 2층 L60 - 링크 : https://festa.io/events/3819 = 문서화가 왕 = 챌린지: 사용자가 소프트웨어를 더 쉽게 사용할 수 있는 좋은 예제가 필요함 해결책: 컨트리뷰션에 고품질의 문서가 포함되도록 하기 교훈: 문서에 우선순위를 두면 사용성이 향상되고 지원 부담이 줄어듬 h...) |
|||
17번째 줄: | 17번째 줄: | ||
https://kennethreitz.org/essays/2013/01/27/documentation-is-king | https://kennethreitz.org/essays/2013/01/27/documentation-is-king | ||
= 3 & 5 = | = 숫자 "3" & 숫자 "5" = | ||
== 3 (뼈대 구성) == | == 숫자 3 (뼈대 구성) == | ||
=== | === 페르소나 분석 === | ||
- 사용자가 누구일까? (독자 분석) | - 사용자가 누구일까? (독자 분석) | ||
=== | === 시나리오 분석 === | ||
- 사용자가 무엇을 할까? (행위 분석) | - 사용자가 무엇을 할까? (행위 분석) | ||
=== | === 문제점과 해결책 제시 === | ||
- 독자가 경험할 만한 어려움이 뭘까? (문제점 분석) | - 독자가 경험할 만한 어려움이 뭘까? (문제점 분석) | ||
=== 3 요약 === | === 숫자 "3" 요약 === | ||
누구를 위한 것인가? | 누구를 위한 것인가? | ||
46번째 줄: | 46번째 줄: | ||
=== 비 문학적 글쓰기 === | === 비 문학적 글쓰기 === | ||
- | - 우리는 문학이 아니라 비문학을 한다는 걸 기억해야 함 | ||
'''< | '''<비문학적 글쓰기에서 중요한 다섯 가지>''' | ||
- 숫자와 데이터 근거로 서술 | - 숫자와 데이터 근거로 서술 | ||
55번째 줄: | 55번째 줄: | ||
- 사물의 상태 변화를 쓸 때문 수동태, 그 외 능동태로 명확하게 서술 | - 사물의 상태 변화를 쓸 때문 수동태, 그 외 능동태로 명확하게 서술 | ||
- 핵심 문장 성분만 남기기 | - 핵심 문장 성분만 남기기 https://blog.naver.com/hard/220937869561 | ||
- 한자어, 외래어, 영어, 전문 용어는 꼭 필요할 때만 (번역체 Goodbye) | - 한자어, 외래어, 영어, 전문 용어는 꼭 필요할 때만 (번역체 Goodbye) https://tech.kakaoenterprise.com/105 | ||
- 문단 하나에 세 문장 이하로 | - 문단 하나에 세 문장 이하로 |
2023년 11월 9일 (목) 20:15 판
1 세미나 정보
- 일시 : 2023년 11월 9일 7:45 ~ 9:00
- 장소 : 한빛미디어 (서울 서대문구 연희로2길 62) A동 2층 L60
- 링크 : https://festa.io/events/3819
2 문서화가 왕
챌린지: 사용자가 소프트웨어를 더 쉽게 사용할 수 있는 좋은 예제가 필요함
해결책: 컨트리뷰션에 고품질의 문서가 포함되도록 하기
교훈: 문서에 우선순위를 두면 사용성이 향상되고 지원 부담이 줄어듬
https://news.hada.io/topic?id=11610
https://kennethreitz.org/essays/2013/01/27/documentation-is-king
3 숫자 "3" & 숫자 "5"
3.1 숫자 3 (뼈대 구성)
3.1.1 페르소나 분석
- 사용자가 누구일까? (독자 분석)
3.1.2 시나리오 분석
- 사용자가 무엇을 할까? (행위 분석)
3.1.3 문제점과 해결책 제시
- 독자가 경험할 만한 어려움이 뭘까? (문제점 분석)
3.1.4 숫자 "3" 요약
누구를 위한 것인가?
이 가이드로 알 수 있는 내용은 무엇인가?
이 가이드를 따라할 때 어떤 어려움이 있는가?
※ 사용자 가이드 뿐 아니라, 정보를 전달해야 하는 대부분의 문서, 블로그 글 등 다양한 곳에서 이와 같은 접근법으로 내용을 구성할 수 있음
3.2 5 (글쓰기 실력 향상 스킬)
3.2.1 좋은 표현 많이 익히기
- 많이 접하고 수집하기
3.2.2 비 문학적 글쓰기
- 우리는 문학이 아니라 비문학을 한다는 걸 기억해야 함
<비문학적 글쓰기에서 중요한 다섯 가지>
- 숫자와 데이터 근거로 서술
- 사물의 상태 변화를 쓸 때문 수동태, 그 외 능동태로 명확하게 서술
- 핵심 문장 성분만 남기기 https://blog.naver.com/hard/220937869561
- 한자어, 외래어, 영어, 전문 용어는 꼭 필요할 때만 (번역체 Goodbye) https://tech.kakaoenterprise.com/105
- 문단 하나에 세 문장 이하로