테크니컬 라이팅/WTD 컨퍼런스 (129) 썸네일형 리스트형 WTD 애틀랜틱 2024 - 라이트닝 토크 첫째날 Abi Sutherland: A Documentation Carol: Scrooge has tech writing lessons for us all 스크루지 이야기를 통해 기술 문서를 작성할 때에 명심해야 할 몇 가지 사항을 이야기합니다. - 오래된 시스템(과거의 유령), 미래의 시스템(미래의 유령)을 따라가지 말고 현재의 시스템을 문서화하세요. - 동료(말리의 유령)의 말에 귀를 기울이고 기존에 만들어진 템플릿을 활용하세요. - 사용자(크래칫 가족)에게 실제로 필요한 것이 무엇인지 알아보고 우선순위를 정하세요. - 커뮤니티를 통해 서로 협력하고 지원하세요.https://youtu.be/DewfY-ult8M?si=clPNXDDTxYlNwAP4 Ariel Kaiser: You just spilled a .. WTD 애틀랜틱 2024 - 테크니컬 라이터에게 언어학이 필요한 이유 테크니컬 라이터가 언어학을 알아야 하는 이유 중 하나는 스타일 가이드를 좀 더 적극적으로 적용할 수 있습니다. 단지 이미 있는 가이드를 찾아보고 적용하는 것이 아니라 이런 가이드가 왜 정해졌고 어떤 규칙에 의해 적용되는지를 알 수 있다는 겁니다. 그럼 혹 스타일 가이드에서 누락된(또는 적용하기 애매한) 항목이 있더라도 이를 확인하고 어떻게 적용해야 할지 알 수 있으며 스타일 가이드에 추가할 수 있다는 것이죠. 수동태를 쓰면 안 된다는 규칙도 상황에 따라서는 수동태가 적절한 경우가 있는데 스타일 가이드에서는 이런 점을 언급하고 있지는 않습니다. 보통은 수동태 예시를 보여주고 이걸 능동태로 바꾸어버리죠. 결론은 스타일 가이드라는 틀에 너무 갇혀 있지 말고 좀 더 깊은 지식을 기반으로 이해하고 사용하자는 것.. WTD 애틀랜틱 2024 - 테크니컬 라이팅을 처음 접하는 이들을 위한 가이드 테크니컬 라이팅을 처음 접하는 이들을 위한 강의입니다. WTD 세션으로 적절한지는 모르겠네요(아마 대부분 비용을 들여 이 행사에 참여하는 분들은 테크니컬 라이팅이 뭔지 어느 정도는 알고 있으니깐요). 그럼에도 영상을 통해 접하는 분들이 있다면 의미가 있겠네요. 많은 오해 중 하나가 테크니컬 라이터는 글만 쓰는 것이라고 오해를 합니다. 하지만 테크니컬 라이팅을 테크니컬 커뮤니케이션이라고도 하는 것처럼 골방에서 글만 쓰는 것은 아닙니다. 개발자나 관련 담당자들과 끊임없이 커뮤니케이션을 해야 합니다(그렇다고 직접적으로 대화를 해야 한다는 것은 아닙니다. 이메일이나 메신저 같은 수단 또는 문서 그 자체로도 커뮤니케이션을 진행할 수는 있습니다). 여러 팀과의 협업을 이야기하면서 상당 부분 너무나 협조적인 동료가 .. WTD 애틀랜틱 2024 - UX팀과 같이 일하기 아웃시스템즈(OutSystems)에서 콘텐츠 개발자로 일하는 2명의 발표자가 함께 합니다. 한 명은 인도, 한 명은 스페인에서 일하고 있습니다. 2021년까지 아웃시스템즈의 문서화는 신규 기능이 나오면 이를 정리하고 문서화했습니다. 전체적인 개요에 대한 정리가 필요했지만 신규 기능을 다루는 것만으로도 벅찬 상태였습니다. 때문에 사용자들은 개별적인 기능은 알 수 있었지만 자신의 목표를 적절한 방법으로 달성하는 정보를 넓은 시각에서 바라볼 수 없었습니다. 그래서 콘텐츠팀에서는 점진적으로 문서를 사용자 중심으로 개선할 계획을 세우고 이를 진행했습니다. 문서화 계획을 세우고 진행하는 과정은 일반적인 과정과 크게 다르지 않습니다. 콘텐츠를 만드는 과정에서 UX팀과 협력해 각 과업마다 user journey를 만들.. WTD 애틀랜틱 2024 - 사용자 온보딩을 테크니컬 라이터가 주도하기 이번 세션에서 설명하는 온보딩은 신규 입사자가 아니라 고객 대상입니다 고객이 새로운 제품에 안정적으로 안착하고 그들의 목표를 달성할 수 있게 도와주는 과정에 대한 이야기입니다. 온보딩을 설명하는 단계는 여러 가지가 있지만 조직에 따라 적절하게 어느 단계에 들어가서(승차) 어느 단계에 나와야 하는지(하차) 명확하게 알아야 합니다. 온보딩은 실제 회사의 수익과 연결이 되는데 테크니컬 라이터가 잘할 수 있는 점을 활용해서 온보딩 프로세스의 주도권을 가지게 되면 테크니컬 라이터가 단지 제품의 부가적인 지원이 아니라 핵심적인 수익이 될 수 있습니다(최근 커뮤니티에 테크니컬 라이터 Role이 사라져서 일자리를 잃었다는 소식이 많은데 대부분 그들의 일이 회사의 수익과 연결된다는 것을 증명하지 못해서 그런 것일 수 있.. WTD 애틀랜틱 2024 - 아랍어 현지화 경험에 대한 이야기 오픈소스는 새로운 시장으로 진출해야 하기 때문에 다른 어떤 소프트웨어보다도 현지화가 중요합니다. 현지화가 되어 있지 않으면 선택받을 가능성이 줄어들기 때문이죠. 쿠버네티스에 대한 현지화 작업은 이전에도 몇 차례 시도가 되었지만 다들 지속적인 활동으로 이어지지 못했습니다. 그러다가 올해 초 SIG-Docs 현지화 서브그룹 리더인 손석호 님이 주도해서 커뮤니티를 하나로 묶어주었습니다. 손석호 님은 ETRI 전문위원으로 다양한 오픈소스 커뮤니티에 참여하고 있고 한글화 팀을 리드하는 분이기도 합니다. 현지화 작업은 단순히 번역만 하는 것이 아니라 다양한 스태프의 참여가 필요하기 때문에 커뮤니티를 리딩하는 누군가가 필요하고 다양한 기여자가 필요합니다. 참고: SIG Docs 및 한글화 기여를 통해 쿠버네티스에 .. WTD 애틀랜틱 2024 - GraphQL 문서를 좀 더 풍성하게 만들기 GraphQL을 사용하면 Introspection을 활용하면 API 문서를 자동으로 생성할 수 있습니다. 하지만 기본 제공되는 문서화 기능만으로는 독자가 맥락을 파악하고 손쉽게 원하는 정보를 얻을 수 없습니다. 때문에 다양한 도구를 사용해서 독자가 정보를 탐색할 수 있게 합니다. 테크니컬 라이터가 별도의 기술 지원을 받지 않고도 GraphQL Playground나 GraphiQL 같은 것을 사용해 기본 문서에 인터랙티브한 기능을 더하고 독자들에게 필요한 정보를 제공할 수 있습니다. 모범적인 사례로 shopify를 보여줍니다(아마 shopify는 자체 개발을 통해 기능을 구현한 것으로 보입니다. 뒤에서 설명하는 발표자의 highnote 사례와는 좀 다릅니다). shopify의 경우 API를 한 페이지에 .. WTD 애틀랜틱 2024 - 코드 기반 다이어그램 사용하기 kong 문서 팀은 6명으로 구성되어 있습디다. 5명의 테크니컬 라이터와 1명의 도큐먼트 엔지니어가 일하고 있습니다. 이 팀에서 13명의 PM과 150여명의 개발 엔지니어. 30여명의 지원 엔지니어와 함께 문서화 작업을 진행합니다. 문서 팀에서 다루어야 할 업무가 점점 많아지고 있어서 가능한 반복적인 작업은 자동화할 수 있도록 노력하고 있습니다. 그 중 하나가 다이어그램이었습니다. 다이어그램을 위해 사용하는 프로그램은 한 가지가 아니었습니다. Figma, Miro, Lucidchart, draw.io 같은 도구를 사용하고 있었습니다. 그리고 그 외에 다른 도구를 사용하기도 했습니다. https://www.figma.com/resource-library/diagramming/https://miro.com/.. 이전 1 2 3 4 ··· 17 다음
