테크니컬 라이팅 (355) 썸네일형 리스트형 좋은 API 문서는 어떻게 만들지? 이번에는 What Factors Contribute to Good API Documentation? 이라는 글입니다.테크니컬 라이터가 활동할 수 있는 시장은 점점 작아지고 그 틈새 시장으로 API 라는 것이 떠오르고 있다는 것을 알았다면. 이제는 좋은 API 문서가 어떤 것인지 알고 자신의 경쟁력을 높이라는 의미겠죠. 단순히 문서 교정자로서 참여하는 것이 아니라 API 기획 단계에서 참여하는 것을 전제로 합니다. API Design 이라는 표현을 사용하고 있네요. 예를 들어 설명하는 내용은 아래와 같습니다....Similarly, using a delete method for all three object types is consistent, but if you instead used “remove” f.. API 문서화 작업은 어떻게 참여할 수 있나요? Scot marvin이 쓴 글을 읽을 때는 몰랐는데 북미 쪽에서 테크니컬 라이터의 지위 또는 일자리가 넉넉치 않나 봅니다. 전통적인 매뉴얼 시장이 아무래도 축소되고 있어서 새로운 시장을 찾아야 하는 위기가 다가오고 있어서 아마도 이번 특집이 마련된 것이 아닌가 싶습니다.2014/10/30 - [인사이드TW] - API 문서화는 누가 하나요? Mary Conner의 글은 이런 점을 솔직하게 드러내고 있습니다. 제목부터가 'How Do You Break into API Documentation?'으로 테크니컬 라이터가 API 문서화라는 새로운 시장에 어떻게 진입할 수 있는지에 대한 가이드입니다. 아직은 시장이 블루오션이라 기존 매뉴얼 작업 대비 1.5~2배 정도 시간 당 수익을 낼 수 있다고 하네요. 원격에.. 2014 한국 TC 컨퍼런스 벌써 세 번째 참석입니다. 내년에도 올 수 있을지 모르겠네요. ^^ 역시 올해도 화요일입니다.작년에 비해 올해는 해외 연사가 많았습니다. 물론 일부 세션은 스폰서 세션이었지만. 컨퍼런스에 대한 소개는 아래 링크를 참고하세요.http://tca.or.kr/RBS/Fn/CommBoard/View.php?RBIdx=Ver1_2&Page=&Idx=143 매년 주제가 달라지긴 하는데 올해 주제는 영화 다이버전트에서 영감을 얻었다고 합니다. 개인적으로 그 영화는 여주인공 빼고는 별로 인상적이지 않아서 ~ 발표 내용은 아래와 같습니다.Let’s start DITA! - 이웃나라 현업 종사자에게 직접 듣는 DITA 이야기Adobe FrameMaker 12를 이용한 XML/DITA 저작과 모바일 출판스마트 매뉴얼대학생들.. API 문서화는 누가 하나요? 아래 내용은 "What Is API Documentation?"이라는 기사 중 일부 내용을 정리한 글입니다.기사는 intercom 2014 9월호에 실린 내용입니다.저자는 Scot marvin 이며 아마존 웹서비스 API 문서 작성에 참여했고 좀 더 찾아보면 API 관련해서 인터뷰나 글을 찾을 수 있습니다.http://scotmarvin.com/ 이란 개인 웹사이트가 있지만 요즘에는 주로 트위터에 글을 올리는 듯.. * 원본 기사는 아래 사이트에 보면 PDF와 연결된 링크가 있습니다. 드롭박스에 보관된 것이라 링크가 사라질지 몰라 관련 글만 소개합니다.http://idratherbewriting.com/2014/09/10/stc-intercom-issue-entirely-dedicated-to-api-d.. KBS 한국어 능력시험 무료 온라인 과정 글을 쓰기 위해서 다양한 경험도 중요하지만 올바르게 언어를 사용하는 방법도 중요합니다.대부분 정규교육과정을 마치고 나도 영어에 대해서는 항상 고민하면서 학원에 다니거나 따로 공부하지만 국어를 공부하는 경우는 많지 않습니다. 그래서 개인적으로 관심을 가진 프로그램이 '한국어능력시험'입니다. 시험 자체가 중요한 것보다는 시험공부를 하면서 국어 공부도 같이 할 수 있다는 장점 때문에 도전해볼 만한 과정이 아닌가 싶습니다.문제는 혼자서 공부하기가 쉽지 않다는 거죠. 교재는 여러 출판사에서 나온 것이 많지만, 강의를 듣기 위해서는 별도 학원에 등록하거나 유료로 제공되는 온라인 과정을 구매해야 합니다. 그러던 중 우연히 홈런(경기도 공공 온라인 교육 사이트)에서 올린 글에 ToKL 과정이 있다는 것을 알았습니다.h.. 2013 한국 TC 컨퍼런스 작년에 이어 두 번째 참석입니다. 매년 19일날 하기로 결정을 했나 봅니다. 화요일 컨퍼런스는 좀 애매한데 ^^ 올해는 컨퍼런스 이름에 '국제'라는 단어가 붙었네요. 그래서 정식 명칭은 '2013 KTCA 국제 컨퍼런스'입니다. 물론 일부 세션이 중국이나 일본, 북미 쪽 사례 발표가 포함되어 있고 해외 참가자들도 생각보다 많아 '국제'라는 이름이 어색한 것은 아닙니다. 컨퍼런스에 대한 소개는 아래 링크를 참고하세요.http://www.tca.or.kr/RBS/Fn/CommBoard/View.php?RBIdx=Ver1_2&Idx=137&PHPSESSID=482bd94d5c1d728755701c640088cf83 발표 내용은 아래와 같습니다.- 사용설명서에 관한 중국의 법규 및 표준- 일본 기업의 중국 국가.. 피라미드 조직도를 다시 생각해보자 smartdraw 블로그에 공개된 글 중에서 허락을 받고 번역해 올리는 글입니다.http://www.smartdraw.com/blog/archive/2013/03/26/is-it-time-to-rethink-the-org-chart.aspx 일부 잘못된 번역이 있을 수 있습니다. 애매한 표현은 원문을 참고하세요.번역/게시를 허락해준 Ken Wilson에게 감사드립니다. 피라미드 조직도를 다시 생각해보자 철도 엔지니어였던 대니얼 맥칼럼(Daniel McCallum)은 1854년 현대적인 조직도 개념을 만들어냈습니다. 맥칼럼이 처음 만든 조직도는 우리가 일반적으로 사용하는 것과 같은 하향식(top-down) 피라미드 모양이 아니었습니다. 피라미드 구조의 조직도는 하버드 대학교수인 앨프리드 챈들러(Alfred.. 매뉴얼 작성을 위한 좋아 보이는 선택 - 쓰리래빗츠 북 개발자들이 문서 작성하는 것을 힘들어한다는 배경에는 도구의 문제도 어느 정도 있지 않나 싶습니다. 개인적으로도 문서 작성 시 워드를 사용하고 있는데 언젠가부터 이런 문제를 겪고 있습니다. 불법 소프트웨어를 사용하는 것도 아니고 윈도우를 다시 설치했음에도 불구하고 이런 문제는 계속 반복되더군요. 한번에 여러 문서를 동시에 작업할 일이 있는 경우에는 거의 작업이 불가능할 정도였습니다. 그리고 문서가 커지면서 전체 문서를 불러오는 중에 오류가 날 때도 있고 문서를 불러오는데 상당한 시간이 걸리더군요. 작년 KTCA 컨퍼런스에서 전시된 제품 중 관심을 가지고 본 제품 중 하나가 워드에 플러그인 형식으로 추가할 수 있는 SmartDocs 입니다.http://www.thirtysix.net/smartdocs/ 기존.. 이전 1 ··· 41 42 43 44 45 다음
