공부 기록/테크니컬라이팅
-
-
영어표현정리 (from 구글 코드랩)공부 기록/테크니컬라이팅 2019. 9. 24. 23:58
gravity: The gravity attribute specifies how a View is aligned within its parent View or ViewGroup. In this step, you center the TextView to be centered vertically within the parent ConstraintLayout. Set the background attribute to @color/colorPrimary. (As you enter @c, choices appear for easy selection.) As a result of changing the width control, the layout_width attribute in the Attributes pan..
-
UX 라이터는 뭘까?공부 기록/테크니컬라이팅 2019. 9. 11. 06:43
테크니컬 라이터 (Technical Writer)란 직업이 해외에선 꽤 오랜 역사를 가졌음에도 불구하고 국내에 알려지기 시작한지는 얼마 되지 않았다. 작은 의미로는 매뉴얼 라이터라고도 하고, 넓은 의미로는 테크니컬 커뮤니케이터라고도 불린다. 그러한 테크니컬 라이터 중에서도 프로그래밍 지식을 겸비해 샘플 코드를 작성하는 라이터들이 있고, 많은 IT기업에서 그러한 역량을 가진 테크니컬 라이터들을 찾고 있다. 이런 테크니컬 라이터들을 해외에서는 API 라이터(Writer)라고 부르기도 하더라. 아직 국내에는 이 직종을 위한 교육 과정이나 자료들이 많이 없어 해외 자료에 의존해야 한다. 수요는 많지만 공급이 따라주지 못한다. (테크니컬 라이터라고 부르기도 하는) API라이터와 더불어 국내에서 최근 꽤 구직 공고..
-
API Writer가 되려면공부 기록/테크니컬라이팅 2019. 9. 5. 08:01
이 글은 테크니컬 라이팅과 픽션에에 대한 블로그를 운영하는 Sarah Maddox의 홈페이지에서 본 To become an API writer 포스팅을 번역하고 그 글을 읽고 든 생각을 정리한 글입니다. 글쓰기 글쓰기에 관해서는 사용자 중심 기술 글쓰기와 다르지 않다. 사용자 매뉴얼처럼 사람들(개발자)에게 어떻게 그것을 사용해야 하는지 말하는 것 뿐이다. 이 경우, 다루는 것은 API, SDK 또는 다른 툴이 될 수 있다. 예전에 존경 받는 개발자들에게 그들이 가장 좋아하는 기술문서 사이트에 대해 물어보았다. 결론은 이 포스팅에 있다: What developers want. 이 포스팅과 코멘트란에 유용한 링크가 있다. build a developer documentation wiki 또 다른 포스트는 개..
-
구글 테크니컬라이터가 전하는 이야기공부 기록/테크니컬라이팅 2019. 9. 2. 23:16
이 글은 구글에서 테크니컬라이터로 일하고 있는 Diane Bates의 발표를 정리한 글이다. 유명 글로벌 기업에서는 테크니컬라이터들이 어떻게 일하는지 궁금했었는데 이 영상을 통해 구글의 테크니컬 라이터들이 일하는 과정(Work Process)과, 더불어 그들이 겪고 있는 어려움들 또한 엿볼 수 있어 좋았다. [원본 영상]How to work with technical writers, SRE Converence 2017 화자는 영어를 전공한 24년 경력의 테크니컬 라이터이다. 테크니컬 라이터로 일하기 전 electronics technician으로 9년동안 일하다가 테크니컬 라이터로서 전향하였고 그 후 크고 작은 회사에서 계약직, 정규직으로 경력을 쌓았다. 그 이후엔 MS에서 대부분의 경력을 쌓았고 현재는..
-
Web API Documentation Best Practices공부 기록/테크니컬라이팅 2019. 8. 27. 06:28
태블릿 PC, 모바일폰, SNS(Social Networking)과 같이 다양한 기술에 대해서 기술하는 Peter Gruenbaum의 포스팅을 번역했다. [원문 보기] Software as a Service(SaaS)의 인기에 힘 입어 많은 Web API가 생겨났지만 API 가이드의 형식(Format)과 질(quality)은 모두 제각각이다. 좋은 문서는 비용을 절감할 뿐 아니라 해당 플랫폼에 관심 있어하는 개발자를 독려하고 흥미를 유지시킨다. 이상적으로 해당 문서는 네 가지 영역을 다루어야 한다: overview, getting started, sample code, and references 이 글에서는 Web API 문서에 특화된 최상의 방법(best practices)을 소개한다. 자동생성 문서(..
-
글쓰기 습관 들이기공부 기록/테크니컬라이팅 2019. 8. 22. 23:34
홈페이지 구성 계획 '기술 블로글를 운영해야겠다'란 계획이 내 머릿속 어딘가에 박혀있던 차에 MICRO SOFTWARE 잡지에서 변성윤님의 개발자를 위한 글쓰기 '글또'에 대해 알게 되었다. 매일 출근 전 한 시간 동안 블로그에 글쓰기 및 공부 계획을 실현 중이던 차에 이 분이 기고한 글과 아래 링크에 공유해주신 슬라이드는 나에게 큰 가이드라인을 주었다. 어떤 글을 작성할 것인가? [개발자를 위한 글쓰 intro 슬라이드 발췌] 튜토리얼/ 시리즈 글 번역 > TW 번역 에러 해결 방안 행사 참여 후기 > 세미나 후기 학습 정리용 > IT 지식 공부 정보 전달 프로젝트 > 앱만들기 회고/일지 책 리뷰 최근 들어 개발자 블로그들을 많이 둘러보게 되었는데 그 블로그들의 분류나 특성들을 나에게 적용했을 ..
-
API 문서 작성법공부 기록/테크니컬라이팅 2019. 8. 21. 22:38
실무에서 사용자 중심의 기술 문서(Technical Documentation)을 주로 다뤘던 나는 개발자를 위한 API 문서를 제작해본 적이 없다. 나 혼자라도 경력을 쌓아야겠단 생각에 API 문서를 작성하는 방법을 구글링 했고, 그러던 중에 Sendbird 블로그에서 작성한 다음 글이 도움이 되어 기록한다. 모든 문장을 1:1로 번역하지 않고, 주요 내용들만 추려서, 그리고 참고할 링크들을 살려서 정리했다. + 참고할 수 있는 다양한 사이트와 기본적인 가이드라인을 소개해준 SendBird에게 감사의 말을 전한다. A Guide to Writing API Documentation [원문 보기] 구조(Structure) 1. 내용이 충실한 소개글, 서론에 집중하라 개발자들에게는 친숙한 기본 개..