부제는 "API Documentation 1: Teaches technical writers how to document structured data. No programming experience required."입니다. 프로그래밍 경험이 전혀 없는 테크니컬 라이터에게 API가 무엇이고 왜 사용하는지. 구조적 데이터가 무엇이고 JSON, XML이 무엇인지 아주 간략하게 설명합니다. 그리고 구조적 데이터를 가지고 간단한 문서를 만드는 과정까지 진행합니다.
Swagger나 XSD 같은 용어가 등장하긴 하지만 구체적으로 어떻게 다루는 것인지 알려주지는 않습니다. 그냥 이런 것이 있다 정도로만 언급하고 필요하면 관련 과정을 수강하세요. 그런 느낌입니다.
강사는 Peter Gruenbaum이고 SDK Bridge라는 회사의 대표입니다. 마이크로소프트 등의 기업에서 테크니컬 라이터와 개발자로 일했었고 2008년부터는 자신의 회사를 경영하고 있습니다. SDK Bridge라는 회사 이름만 보면 뭐 하는 회사인지 애매한데 소프트웨어 개발과 SDK&API 문서 개발이 주 업무입니다. 좀 독특한 회사죠.
과정은 간단하지만(아마 개발 경력이 있는 테크니컬 라이터라면 이게 뭐야 싶을 겁니다) 아무것도 모르는 상태에서 API를 다루어야 하는 테크니컬 라이터에게는 권장할 만한 과정입니다. 중간중간 실습이 있긴 한데 뭐 그냥 넘어가도 괜찮습니다.
중간에 API 트렌드 차트를 보여줄 때 2013년이 마지막이었는데 이 강의 자체가 8년전 그러니깐 2014년 정도에 공개된 것이 아닌가 싶습니다. 뭐 그 사이에 변경된 것은 없지만 툴 소개에서 지금은 개발이 중단된 툴을 소개하는 부분도 있긴 합니다.
문서화 관련해서는 강사가 이야기하는 방법이 정답이 아니라고 무척 강조하면서 이야기합니다. 구조적인 데이터를 문서화할 때 테크니컬 라이터가 알아야 할 개념 정도만 이해하는 것을 목표로 하면 문제는 없습니다.
https://www.udemy.com/course/api-documentation-1-json-and-xml/
이어지는 강의는 Learn API Technical Writing 2: REST for Writers 라는 강의입니다.
https://www.udemy.com/course/learn-api-technical-writing-2-rest-for-writers
* 툴 소개하는 부분에서 그냥 읽고 넘어가면 강의 수강 완료 처리가 되지 않습니다.
링크를 한 번 클릭해주어야(이 글을 읽고 지시에 따라 링크를 클릭했다) 완료가 되네요.
다른 강의는 그렇지 않던데 아마 진행 옵션인가봅니다.
