본문 바로가기

알아두면 좋은 IT 지식/Technical Writing

(5)
테크니컬라이터가 되려면 무엇을 공부해야 할까? 위 질문에 답하기 위해서 미국 카네기 멜런 대학교의 테크니컬커뮤니케이션 전공과목을 가져와 봤다. 우리나라도 하루빨리 테크니컬커뮤니케이션에 대한 중요성을 깨닫고 대학교에서도 전공이 개설되면 좋겠다. (영어로 된 글을 파파고로 그대로 번역하여 오역이 있을 수 있다.) 수학 전제 조건 다음 중 하나 21-111 미적분 I 21-112 미적분 II 21-120 미분학 21-127 수학의 개념 통계 필수 조건 36-200 데이터 추론 컴퓨터 과학 필수 조건 15-110 컴퓨팅의 원리 15-112 프로그래밍과 컴퓨터 과학의 기초 양식 요구 사항에 대한 부서 핵심 조사(1개 코스, 9개 단위): 76-260 서식 조사: 픽션 76-261 형태조사: 창조적 논프티콘 76-262 형태조사: 논픽션 76-265 형태조사:..
테크니컬라이팅 작성언어, 작성도구 및 문서관리 처음 문서관리를 시작했을 때에는 주로 MS OFFICE 제품들을 사용했다. Word, Ppt, Excel 등으로도 충분히 원하는 문서를 만들고 pdf로 변환하여 관리할 수 있었다. 그러다가 전문적인 언어와 도구를 사용해야겠다고 느낀 이유는 크게 세가지이다. 통일성 문서변환 버전관리 처음 작성도구로 선택한 것은 웹환경에서 문서를 편집할 수 있는 WYSIWYG(What You See Is What You Get)방식의 tistory와 gitbook이였다. 인터넷에 글을 올리는 느낌이라 재미도 있고 편했지만 양식이 너무 제한적이고 공유를 위해서 문서로 변환하는 작업이 마음에 들지 않았다. tistory는 브라우저의 출력기능을 통해서 PDF로 변환했는데 메뉴나 tistory로고가 박혀서 좋지 않았고 gitboo..
markdown 사용법 typora 툴에서 md파일 작성 후 tistory의 markdown소스코드에 복붙했는데 완전 100% 적용되지는 않는 것 같지만 90%이상 호환이 되는 것으로 보인다. markdown 사용법 1.목차 소스 [1.목차](#1.목차) [2.글머리](#2.글머리) [3.글씨체](#3.글씨체) [4.목록](#4.목록) [5.수평선](#5.수평선) [6.링크](#6.링크) [7.사진첨부](#7.사진첨부) [8.코드블럭](#8.코드블럭) [9.인용구](#9.인용구) [10.수식](#10.수식) [11.표](#11.표) [12.각주](#12.각주) 결과 1.목차 2.글머리 3.글씨체 4.목록 5.수평선 6.링크 7.사진첨부 8.코드블럭 9.인용구 10.수식 11.표 12.각주 2.글머리 소스 # 글머리#1 ## 글..
asciidoc Tutorial asciidoc설치 후 .adoc문서를 .pdf로 변환하는 성공경험을 목적으로 하는 tutorial 설치환경 : centOS-7.3-64 1. rvm설치 curl -sSL https://get.rvm.io | bash -s stable (public key 관련 오류 발생 시 하단 '오류처리' 참고) source /etc/profile.d/rvm.sh rvm reload rvm list known 2. ruby 설치 rvm install ruby-2.4 rvm use 2.4 which ruby 3. asciidoctor 설치 gem install asciidoctor 4. coderay 설치 gem install coderay pygments.rb 4. asciidoctor-pdf 설치 gem insta..
테크니컬라이팅이란? 국내에도 테크니컬 라이터라는 직업과 테크니컬 라이팅이라는 업무가 존재는 하지만 많지 않고 실제로 팀 단위로 진행되거나 전문화되어 체계가 잡혀있는 경우가 많지 않은 것 같다. 인터넷에서 검색을 하다보면 많은 테크니컬 라이팅 기술이 나오는데 대부분 외국의 사례를 가져와서 번역한 내용이 많고 나또한 그런 글들 중 중요하다고 생각하는 핵심 내용만 정리하는 목적으로 글을 써본다. 문서의 종류 구분 문서를 목적에 따라서 분리하여 작성하기 위한 구분 1. Tutorial (튜토리얼) :초보자를 학습위주로, 사용자가 기본적인 기술을 익힐 수 있도록 합니다. 2. How-to guide (How-To가이드) :정해진 결과를 달성하기 위해서 사용자가 기본적인 지식을 가지고 있다고 가정하고 문제 해결방법을 알도록 합니다. ..