API문서작성법
-
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)을 소개한다. 자동생성 문서(..
-
API 문서 작성법공부 기록/테크니컬라이팅 2019. 8. 21. 22:38
실무에서 사용자 중심의 기술 문서(Technical Documentation)을 주로 다뤘던 나는 개발자를 위한 API 문서를 제작해본 적이 없다. 나 혼자라도 경력을 쌓아야겠단 생각에 API 문서를 작성하는 방법을 구글링 했고, 그러던 중에 Sendbird 블로그에서 작성한 다음 글이 도움이 되어 기록한다. 모든 문장을 1:1로 번역하지 않고, 주요 내용들만 추려서, 그리고 참고할 링크들을 살려서 정리했다. + 참고할 수 있는 다양한 사이트와 기본적인 가이드라인을 소개해준 SendBird에게 감사의 말을 전한다. A Guide to Writing API Documentation [원문 보기] 구조(Structure) 1. 내용이 충실한 소개글, 서론에 집중하라 개발자들에게는 친숙한 기본 개..