New Relic에서 테크니컬 라이터를 위한 외부 초빙 교육을 진행했고 그에 대한 회고 같은 세션입니다. 발표자는 교육을 진행했던 New Relic의 Michelle Fredette와 강사인 Chris Cowell입니다.
New Relic은 성능 모니터링을 위한 클라우드 소프트웨어를 개발하는 업체이며 약 2300명이 일하는 기업이라고 합니다. 테크니컬 라이터의 규모는 모르겠지만, 회사 규모가 있는 만큼 테크니컬 라이터가 적지 않을 것으로 보입니다.
Chris Cowell는 개발자 경력을 가지고 있으며 지금은 개인 사업자(?)로 기술 배경이 없는 사용자를 위한 교육을 전문적으로 진행한다고 합니다. 1:1 교육도 진행하고 대규모 그룹 강의도 하고요. 개인 강의는 시간당 50달러이고 기업 강의는 1명당 100달러입니다. 1:1일 때도 같은 비용인지는 모르겠네요~
이 분의 슬로건은 "Painless technical training for less-technical people"라고 합니다. 멋지군요.
https://www.christophercowell.llc/
교육을 진행한 배경은 개발자 문서 사이트 개편을 준비하면서 온라인 문서 내에서 실제 API를 호출하고 테스트할 수 있는 플랫폼 전환까지 필요했던 것이라고 합니다. 그리고 테크니컬 라이터의 API에 대한 이해를 빠른 시간 내에 끌어올리고자 했던 것도 있고요. 이론적인 내용보다 실습을 통해 경험할 수 있도록 커리큘럼을 요청했다고 합니다.
세션의 주요 내용은 7가지 교육 원칙에 대한 설명인데 딱히 테크니컬 라이터를 위한 교육의 특성은 아니지만 그냥 참고하면 좋을 듯합니다.
교육을 준비하면서 담당자인 Michelle과 이야기를 했고 관심사에 대한 부분에서 처음에는 REST API 문서화에 대한 이야기가 관심사였나 싶었지만 이야기를 해보니 REST API가 무엇인지에 대해 알고 싶어 했고 다른 곳에서는 어떤 식으로 문서화를 운영하는지 궁금해했다고 하네요.
뒤에서 한 번 더 언급하긴 했는데, 많은 경우 개별 교육을 진행하면서 기존 패키징 된 교육 커리큘럼을 그대로 사용하는 곳이 많다고 합니다. 하지만 청중의 특성이 명확히 다르고 각 교육에서 얻고자 하는 점이 다르기 때문에 미리 이야기가 되고 진행이 되어야 한다고 하네요. 그러면서 저렇게 포장된 샌드위치 비유를~
또 하나 흥미로운 원칙은 기술 자체를 설명하기보다는 비유를 통해 쉽게 이해할 수 있도록 설명한다라는 겁니다. 아무래도 기술적 배경이 없는 청중을 대상으로 하다 보니 그런 것이 아닌가 싶습니다.
https://pronovix.com/event/api-docs-virtual-2020/michelle-fredette-chris-cowell
Michelle Fredette & Chris Cowell - Eight hours to API literacy: a fast, fun on-ramp for writers
New Relic hired an external trainer to teach members of the Tech Docs and UX teams REST API documentation best practices. While the team members already learnt about API reference writing through documenting them, mostly from classes aimed at engineers. Em
pronovix.com
