본문 바로가기

728x90

테크니컬 라이팅/WTD 컨퍼런스

(114)
WTD 포틀랜드 2024 - 디자인 리뷰를 통해 맥락이 담긴 문서 만들기 Shawn Aldridge는 컴퓨터 사이언스로 학부를 로보틱스로 석사학위를 받고 소프트웨어 엔지니어로 일했습니다. 현재는 데이트앱(Tinder)을 만들고 있습니다. 틴더의 경우 약 300명의 엔지니어가 있습니다. 사용자를 3억명 정도로 계산하면 1명의 엔지니어가 100만 명의 사용자를 담당하게 됩니다(적절한 비유인지는 모르겠으나). 하여간 그래서 1명의 엔지니어가 매우 효율적으로 일해야 하고 이를 위한 재량권을 가지게 된다고 합니다. 대략 40개의 팀(프로젝트)으로 작업을 진행하는데 이 각각의 팀에서 문서를 다루다보니 역시 문제가 발생합니다. 4가지 형태로 문제를 정의할 수 있습니다. - Fragmentation: 서로 다른 문서 플랫폼, 문서 스타일, 작성 프로세스 - Brittleness: 문서에 작..
WTD 포틀랜드 2024 - 내부 기술 문서는 어떻게 관리하나요? 스트라이프는 2010년 시작해서 몇 년 동안 작은 규모(수 백 명 수준)의 스타트업이었습니다. 2016년부터 회사의 규모가 커지고 제품도 늘어나게 됩니다. 특히 코로나 기간 동안 온라인 상거래가 늘어나면서 스트라이프 사용자 역시 빠르게 늘어나게 됩니다. 조직이 성장하면서 내부 문서에 대한 불만이 커져갔습니다. 이전에는 누가 어떤 작업을 했고 어떤 문서가 어디있는지 알 수 있으니 큰 문제가 아니었는데 조직이 커지면서 점점 문제로 자리 잡았습니다. 스트라이프에서는 2년에 한 번씩 내부 개발자를 대상으로 설문을 진행합니다. 어떤 것이 개발에 방해가 되는지 확인하기 위한 용도입니다. 설문 결과 내부 문서에 대한 불만이 많음이 드러났습니다. 불만을 몇 가지로 정리해 보면 다음과 같습니다. - Fragmentati..
WTD 포틀랜드 2024 - 스토리 포인트 기반 문서 평가하기 발표자는 포틀랜드에서 Dutchie라는 회사의 테크니컬 라이터로 일하고 있습니다. 여기는 대마초 스타트업입니다. 2021년도 기사를 보면 대마초 관련 스타트업 중에서 처음으로 1조 가치를 넘었다는 이야기가 있네요. 대마초 관련 산업이 얼마나 큰지 알 수 있는 소식이죠. 실제 이전 테크니컬 라이터 인턴 인터뷰에서도 대마초 관련 기업에서 인턴을 했다는 이야기도 있었습니다. 2021.05.28 - [테크니컬 라이팅] - 테크니컬 라이터 인턴은 어떤 일을 할까? 테크니컬 라이터에게 평가나 측정은 쉽지 않은 도전입니다. 수치화된 결과를 만들기 어렵기 때문에 주관적인 접근을 사용하기도 하지만 말 그대로 주관적이기 때문에 일관성 있는 결과를 만들기 어렵습니다. 때문에 어떤 하나의 프레임워크를 정하고 이에 따라 평가하..
WTD 포틀랜드 2024 - OpenAPI 도입 가이드: 테크니컬 라이터를 위한 4단계 OpenAPI를 사용하기로 했다면 다음 4가지 단계를 따르는 것을 권장합니다(물론 발표자의 개인적인 의견이므로 절대적인 것은 아닙니다). 1. 새로운 문서 만들기(New documentation) 일반적으로 OpenAPI 문서화를 처음 접하는 이들이 가장 어려워하는 부분입니다. 일반 문서로 작성된 내용을 컴파일할 수 있는 OpenAPI로 옮기는 부분이죠. 특히 테크니컬 라이팅에 익숙한 이들이 더 어려워합니다. 왜냐하면 OpenAPI는 테크니컬 라이팅보다는 코딩에 가깝기 때문이죠. 때문에 테크니컬 라이터처럼 생각하지 말고 개발자처럼 생각해야 합니다. 아래 이미지의 경우 accountValue라는 필드값이 필수인데 입력할 수 있는 문자 길이 범위는 0~50으로 초안이 작성되어 있습니다. 이 두가지 내용은 서..
WTD 포틀랜드 2024 - 문서화 프로세스를 위한 교과서적인 가이드 발표자는 스타트업에서 경험하는 복잡한 문서화 경험을 마치 엉킨 이어폰줄에 비교합니다. 금방 해결될 것 같지만 자꾸만 꼬여버리지요. 그래서 이를 풀어낼 수 있는 방법을 안내하는데 너무 교과서적인 이야기를 합니다. 분명 주제는 스타트업이고 이런 걸 다 챙길 여력이 없을 텐데 말이죠. 이 분 커리어를 보면 최근 테크니컬 라이팅 분야 컨설팅을 같이 하고 있습니다. Fabric이라는 기업에서 일하면서 개인적으로 컨설팅도 같이 하는 듯합니다. 그래서 그런지 뭔가 발표 내용은 컨설팅 자료에 적합한 그런 내용이네요. 좀 더 구체적으로 활용할 수 있는 템플릿이었으면 어떨까 하는 아쉬움이 남네요. 발표 내용 중에 인상적인 그림이었는데 자세하게 다루지는 않고 그냥 넘어가서 좀 아쉽네요. Q&A에서 규모가 좀 더 큰 조직이나..
WTD 포틀랜드 2024 - 제품 내 도움말은 정말 도움이 되는가? 동영상 제목과 별개로 발표의 제목은 "Creating contextual content experiences"입니다. IBM에서 일하던 시절(2003년부터 2020년까지) Michael Priestley, Don Day 같은 DITA 교과서에 나오는 분들과 같이 일했다고 합니다. 지금은 "Automation Anywhere"라는 회사에서 DITA 자동화 관련 작업을 하고 있다고 합니다. 중간에 뭔가 통합했다는 뭐 그런 이야기가 나오는데 "Zoomin for Pendo"라는 제품인가 봅니다. 내부적인 요구사항에 대해 솔루션을 선택했고 이를 통합해서 제공한다는 뭐 그런 이야기입니다. 그 과정에서 이러이러한 어려움이 있었고. 뭐. 그런 이야기죠.https://www.zoominsoftware.com/zoomi..
WTD 포틀랜드 2024 - R&R을 통해 한 단계 높은 성과 만들기 Calvin Fung는 경력이 화려합니다. 딱 엘리트 코스를 따라갔습니다. 졸업하기 전에 마이크로소프트에서 1년간 인턴을 하고 5년간 정규직으로 일을 시작합니다. Operation specialist(지원팀에 가깝다고 합니다. 한국어로는 딱 명확한 번역이 애매하네요)로 일했는데 그다음 커리어는 테슬라에서 테크니컬 라이터로 일을 하게 됩니다. 그리고 AWS로 옮겨서 테크니컬 라이터, 테크니컬 아카데미, 엔지니어들의 역할을 가지고 일을 했습니다. 때문에 이번 강연에서 이야기하는 레벨업의 수준이 좀 맞지 않을 수도 있을 겁니다(라고 생각했는데 그렇게 디테일하게 들어가지는 않네요). R&R은 의무적으로 작성하긴 하지만 이를 제대로 활용하지는 못합니다. R&R에서 할 수 있는 일의 단계를 구분하고 내가 얼마나 성..
WTD 포틀랜드 2024 - 문서화는 봄날의 햇살입니다. 좀 더 자세한 이야기. "2022 데브옵스 현황 보고서 데이터 심층 분석: 문서화는 봄날의 햇살입니다"와 관련된 세션입니다.https://koko8829.tistory.com/2413 연구 결과에 대해 간단하게 설명하는 자리였구요. 일단 해당 문서는 외부에 공개되는 기술 문서가 아니라 조직 내부에서 사용하는 기술 문서에 대한 연구였다고 합니다(좀 설명이 애매하긴 한데). 엔지니어들이 자신의 팀에서 관리하는 기술 문서가 개발 프로세스에 어떻게 영향을 주는지 확인하는 작업이었다고 합니다. 2023년 보고서까지 공개가 되어있구요. 2024년 서베이가 진행되고 있습니다. 주로 북미 쪽에서 나온 답변을 위주로 작성된 보고서이기 때문에 문화적인 차이에 따라 다를 수 있습니다.  문서 품질과 관련된 8개 속성과 관련된 질문이라고 합니다. ..

반응형