테크니컬 라이팅/WTD 컨퍼런스 (141) 썸네일형 리스트형 WTD 호주 2024 - API 문서와 잡다한 자료를 AI를 활용해 개발자 가이드로 정리하기 자료 화면 타이틀은 "WHY DON'T WE JUST GET AI TO WRITE THE DOCS?"입니다. 발표자는 호주에서 Shippit이라는 multi-carrier shipping software 기업에 24년 2월 합류했습니다. 그전에는 테크니컬 라이터가 없었고 각 업무 담당자가 문서를 작성했습니다. 이렇게 작성된 문서가 꽤 많았죠. 내용도 적절했습니다. 하지만 2가지 문제가 있었습니다. - 각 문서의 내용은 적절했지만 구성이 제각각이었고 - 사용자에게 필요한 일부 문서는 내부 시스템에서만 관리되고 있었습니다. 그래서 필요한 것은 - 콘텐츠를 모아서(Get all the content together) - 사용자가 쉽게 찾을 수 있고(Where developers could find it) -.. WTD 호주 2024 - 복잡한 조직을 위한 네이밍 가이드라인 만들기 Jay Stephens는 CSIRO에서 2022년 7월부터 일했는데 그 경험을 공유합니다. CSIRO는 호주의 연방과학산업연구기구(Commonwealth Scientific and Industrial Research Organisation)라고 합니다(organization을 영국식으로는 organisation으로 표기합니다). CSIRO은 꽤 규모가 큰 조직으로 각 조직, 팀, 프로젝트가 사일로화되고 서로 다른 문화, 기업 미션과 과학 미션이 혼합, 데이터 보존과 관련된 규정의 복잡성으로 인해 어려움에 직면했습니다. 이전에도 네이밍 규칙이 없었던 것은 아닙니다. 하지만, 지나치게 엄격한 규칙과 유연성 부족으로 인해 모호함과 규정 미준수로 이어져 실패했습니다.과거의 실패와 현재의 상태를 분석한 후 브레인.. WTD 호주 2024 - Don't Make Me Code 개발자 경험(Developer Experience)에 대해 이야기합니다. 앞부분에서는 인간 심리와 UX에 대해 다루고 뒷부분에서 DX를 살짝 다룹니다. 앞부분의 이야기는 대니얼 카너먼의 책 "생각에 관한 생각(Thinking, Fast and Slow)"과 스티븐 크룩의 책 "사용자를 생각하게 하지 마!(Don’t Make Me Think : A Common Sense Approach to Web Usability)"에 대한 이야기입니다. 청중들과 간단한 퀴즈 형식을 통해 흥미롭게 개념을 설명합니다. 개발자 경험에 대한 이야기는 "Don't Make Me Code"라는 타이틀로 시작하는데요. 개발자가 새로운 서비스 또는 제품을 접했을 때 "코드"를 직접 작성하지 않고 따라갈 수 있어야 한다는 겁니다. 같.. WTD 애틀랜틱 2024 - 라이트닝 토크 둘째날 Erich Studer: Make developers your friends with codemermaid.js 같은 도구를 사용할 때는 자동화와 연계해서 사용해야 한다는 이야기입니다. 보통은 문서화 솔루션에 통합되어 관리되기 때문에 별도로 mermaid 관련 코드를 관리할 필요가 없긴 한데, 개별적으로 작업한다면 그렇다는 이야기가 아닌가 싶네요. 뭐 딱히 새로운 이야기는 아닙니다.https://youtu.be/8CpAJf-PKn4?si=8f7XfKCN0vKAjT4y Erin White: Killing Serial Killer Cliches학부에서 범죄 심리학을 공부하고 정보과학으로 학위를 받았습니다. 독특한 커리어네요. 창작물에서 연쇄살인범 캐릭터를 효과적으로 만드는 팁을 이야기합니다. 음. 개인적으.. 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를 만들.. 이전 1 2 3 4 5 ··· 18 다음
