테크니컬 라이팅 (349) 썸네일형 리스트형 WTD 애틀랜틱 2024 - UX팀과 같이 일하기 아웃시스템즈(OutSystems)에서 콘텐츠 개발자로 일하는 2명의 발표자가 함께 합니다. 한 명은 인도, 한 명은 스페인에서 일하고 있습니다. 2021년까지 아웃시스템즈의 문서화는 신규 기능이 나오면 이를 정리하고 문서화했습니다. 전체적인 개요에 대한 정리가 필요했지만 신규 기능을 다루는 것만으로도 벅찬 상태였습니다. 때문에 사용자들은 개별적인 기능은 알 수 있었지만 자신의 목표를 적절한 방법으로 달성하는 정보를 넓은 시각에서 바라볼 수 없었습니다. 그래서 콘텐츠팀에서는 점진적으로 문서를 사용자 중심으로 개선할 계획을 세우고 이를 진행했습니다. 문서화 계획을 세우고 진행하는 과정은 일반적인 과정과 크게 다르지 않습니다. 콘텐츠를 만드는 과정에서 UX팀과 협력해 각 과업마다 user journey를 만들.. RDB와 NoSQL 이야기 옛날 옛적, 데이터 마을에는 두 명의 강력한 수호자가 살고 있었습니다. 그들의 이름은 RDB와 NoSQL이었죠. 이 둘은 모두 왕국의 데이터를 안전하게 지키고 관리하는 임무를 맡고 있었지만, 서로 다른 방식으로 일을 처리했습니다. RDB는 질서를 사랑하는 수호자였습니다. 그는 모든 것을 깔끔하게 정리하는 것을 좋아했죠. "모든 데이터는 정확한 자리에 있어야 해!"라고 말하곤 했습니다. 그의 세계관에서는 모든 것이 표로 나뉘어 있었고, 각 데이터는 미리 정해진 규칙에 따라 저장되었습니다. "이건 엄격한 규칙이지만, 그래야만 모든 것이 완벽하게 맞아떨어지지!" RDB는 항상 이렇게 말하며, 데이터를 정확하게 관리했습니다. 그는 데이터를 서로 연결하고, 복잡한 관계를 만들어내는 데도 능숙했죠. 그래서 사람들이.. JSON(제이슨)과 XML(엑스엠엘) 이야기 옛날 옛적, 데이터 마을에는 두 명의 정보 배달원이 살고 있었어요. 그들의 이름은 JSON(제이슨)과 XML(엑스엠엘)이었죠. 마을의 모든 사람들이 정보를 주고받을 때, 이 두 친구는 그 정보를 정확하고 안전하게 전달하는 중요한 역할을 맡았습니다. 정보 배달원으로서 그들은 사람들 사이에서 데이터를 전달하는 일을 했어요. 하지만 그들이 일을 처리하는 방식은 조금 달랐죠. 제이슨은 매우 빠르고 간결한 배달원이에요. 그는 항상 가벼운 가방을 들고 다니며, 필요한 정보만 딱딱 정리해서 전달했어요. 정보를 전달하면서 불필요한 설명이 없었고, 누구나 쉽게 이해할 수 있는 방식으로 정보를 전했죠. 그는 "최대한 간단하게!"라는 철학을 가지고 있었어요. 덕분에 사람들은 그가 전해주는 정보를 빠르게 받아보고 처리할 수 .. WTD 애틀랜틱 2024 - 사용자 온보딩을 테크니컬 라이터가 주도하기 이번 세션에서 설명하는 온보딩은 신규 입사자가 아니라 고객 대상입니다 고객이 새로운 제품에 안정적으로 안착하고 그들의 목표를 달성할 수 있게 도와주는 과정에 대한 이야기입니다. 온보딩을 설명하는 단계는 여러 가지가 있지만 조직에 따라 적절하게 어느 단계에 들어가서(승차) 어느 단계에 나와야 하는지(하차) 명확하게 알아야 합니다. 온보딩은 실제 회사의 수익과 연결이 되는데 테크니컬 라이터가 잘할 수 있는 점을 활용해서 온보딩 프로세스의 주도권을 가지게 되면 테크니컬 라이터가 단지 제품의 부가적인 지원이 아니라 핵심적인 수익이 될 수 있습니다(최근 커뮤니티에 테크니컬 라이터 Role이 사라져서 일자리를 잃었다는 소식이 많은데 대부분 그들의 일이 회사의 수익과 연결된다는 것을 증명하지 못해서 그런 것일 수 있.. WTD 애틀랜틱 2024 - 아랍어 현지화 경험에 대한 이야기 오픈소스는 새로운 시장으로 진출해야 하기 때문에 다른 어떤 소프트웨어보다도 현지화가 중요합니다. 현지화가 되어 있지 않으면 선택받을 가능성이 줄어들기 때문이죠. 쿠버네티스에 대한 현지화 작업은 이전에도 몇 차례 시도가 되었지만 다들 지속적인 활동으로 이어지지 못했습니다. 그러다가 올해 초 SIG-Docs 현지화 서브그룹 리더인 손석호 님이 주도해서 커뮤니티를 하나로 묶어주었습니다. 손석호 님은 ETRI 전문위원으로 다양한 오픈소스 커뮤니티에 참여하고 있고 한글화 팀을 리드하는 분이기도 합니다. 현지화 작업은 단순히 번역만 하는 것이 아니라 다양한 스태프의 참여가 필요하기 때문에 커뮤니티를 리딩하는 누군가가 필요하고 다양한 기여자가 필요합니다. 참고: SIG Docs 및 한글화 기여를 통해 쿠버네티스에 .. PNG(피엔지)와 JPEG(제이펙) 이야기 옛날 옛적, 디지털 마을에는 두 명의 화가가 살고 있었습니다. 그들의 이름은 PNG(피엔지)와 JPEG(제이펙)였어요. 두 형제는 모두 아름다운 그림과 사진을 다루는 일을 했지만, 그들은 서로 다른 방식으로 세상을 바라보고 있었습니다. 그들은 "빛의 화가"라는 불리었습니다. 그들은 빛과 색을 다루는 예술가로서, 세상의 아름다움을 다양한 방식으로 표현하는 일을 맡았어요. 하지만 두 형제는 각기 다른 도구와 기법을 사용하여 작품을 완성했습니다. 피엔지는 언제나 섬세하고 세밀한 작업을 선호했습니다. 그는 빛의 모든 색을 정확하게 표현하고, 투명한 부분까지도 완벽하게 다룰 수 있는 능력을 가지고 있었죠. 그의 작품은 언제나 선명하고, 배경이 없는 순수한 형상을 보여주었습니다. 그래서 사람들은 투명한 유리나 맑은.. SVN(서브버전)과 Git(깃) 이야기 옛날 옛적, 파일 마을에는 커다란 저장소가 있었습니다. 이 저장소는 마을 사람들 모두가 함께 사용하는 곳이었죠. 모든 사람은 자신이 만든 문서나 그림을 저장하고, 필요할 때마다 꺼내 쓸 수 있었습니다. 하지만 문제가 있었어요. 누군가가 공동으로 사용하는 문서를 수정하면, 다른 사람이 어떤 것을 수정했는지 알 수 없었고, 가끔은 실수로 중요한 파일이 덮어씌워지기도 했습니다. 마을 사람들은 혼란스러워하며 더 나은 방법을 찾기 시작했습니다. 그러던 어느 날, SVN(서브버전)이라는 지혜로운 관리자가 나타났습니다. 서브버전은 저장소에 커다란 기록 책을 만들고, 마을 사람들이 문서를 수정할 때마다 그 변화를 기록해 두었습니다. 이제는 누가 언제 무엇을 수정했는지 알 수 있었고, 실수로 파일을 덮어써도 이전 버전으.. 평온한 수호자의 전령 HTTPS 이야기 옛날 옛적, 인터넷 마을에는 폭풍의 길을 달리는 전령(HTTP, Herald of the Tempest Paths)이라는 별명을 가진 젊은 전령이 살고 있었어요. HTTP는 매우 빠르고 성실하게 정보를 전달하는 임무를 맡고 있었죠. 그는 마을 곳곳을 누비며 사람들에게 다양한 소식과 이미지를 전해주었어요. 하지만 HTTP에게는 한 가지 큰 문제가 있었어요. 그의 가방에는 자물쇠가 없어서, 누구나 그가 나르는 편지를 쉽게 열어볼 수 있었던 거예요. 어느 날, HTTP는 중요한 편지를 전하던 중 도적들에게 편지를 빼앗기고 말았어요. "이대로는 안 되겠어!" HTTP는 결심했어요. "더 이상 내 소중한 편지가 위험에 빠지게 둘 순 없어. 나는 더 강해져야 해!"라고 생각했어요. 그렇게 HTTP는 험난한 여정을 .. 이전 1 2 3 4 ··· 44 다음