본문 바로가기

728x90

IntercomSept_WEB

(4)
쓸만한 샘플 코드는 어떻게 만드나요 How to Write Helpful Code Samples 라는 글입니다. Sarah Maddox는 구글에서 테크니컬 라이터로 일하고 있으며 그 전에는 아틀라시안, HP 등에서 일했다고 합니다. 9년 동안은 엔지니어로 그 후로는 테크니컬 라이터로 일하고 있네요. 현재 하고 있는 일이 주로 구글맵 관련된 일이라서 그런지 주로 구글맵 사례로 설명을 해주고 있습니다. 블로그에 올린 글 중에 How to write sample code 라는 글이 있는데 내용은 비슷한 것 같네요.http://ffeathers.wordpress.com/2013/12/21/how-to-write-sample-code/ 이전 글에서 다룬 것처럼 API 문서에 들어가는 텍스트 영역은 사용자가 직접 접하는 부분이고 누구나 쉽게 사용할 ..
좋은 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배 정도 시간 당 수익을 낼 수 있다고 하네요. 원격에..
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..

반응형