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