테크니컬 라이팅 (353) 썸네일형 리스트형 WTD 포틀랜드 2023 - 크라우드 소싱 방식의 문서화 프로젝트 진행하기 이번 발표에서 설명하는 Splunk Lantern이라는 프로젝트의 방식이 좀 낯설어서 전체적인 내용을 제대로 이해하지 못했습니다. 뭐 그럼에도 부족한 자원을 가지고 기여자들과 함께 문서화 프로젝트를 진행하는 여러 팁에 대해 설명하고 있는 것이라서 유익한 팁들만 받아들이면 되지 않을까 싶습니다. Splunk Lantern은 - 공식 제품 문서와 다르게 릴리스 일정과 상관없이 운영됩니다. - 커뮤니티가 아니기 때문에 누구나 문서화에 참여할 수는 없습니다. - 마케팅 지향적인 문서를 만들지 않습니다. - 기술지원 요청에 대응해서 문서를 만들지는 않습니다. Splunk Lantern은 고객을 위한 디지털 셀프서비스 가이드입니다. 현장에서 고객과 함께 일하는 엔지니어들이 자료를 만들고 고객의 성공을 돕습니다. 라.. WTD 포틀랜드 2023 - 대규모 엔지니어 조직에서 생산성 높은 문서화 프로세스 만들기 Datadog에는 12명의 테크니컬 라이터가 일하고 있습니다. 일반적인 개론에서는 1명의 테크니컬 라이터가 10~15명 정도 엔지니어와 함께 일하는 것이 이상적이라고 합니다. 미국 통계에서는 약 30명의 엔지니어를 1명의 테크니컬 라이터가 대응하고 있다고 합니다. 하지만 Datadog에서는 2000여 명의 엔지니어가 일하고 있고 12명의 테크니컬 라이터는 이들 2000여 명의 엔지니어와 매일 커뮤니케이션을 진행합니다. 물론 2000여 명의 엔지니어가 모두 테크니컬 라이터 또는 문서화에 긴밀하게 참여한다고 할 수는 없습니다. 그중에 PM이나 팀 리더와 주로 많은 작업을 합니다. 사내 엔지니어 외에도 고객, 사용자, 파트너, 기술지원, 커뮤니티, 세일즈, 번역을 담당하는 이들과도 함께 일을 해야 합니다. 이.. 2023년 8월 테크니컬 라이팅 이런 저런 소식 8월 1일 8월 첫 소식입니다. 지난 7월 27일 토스 페이먼트 트위터(이제는 엑스라고 해야 하나요 ㅠㅠ) 계정에 한글 변수명 사용에 대한 글이 올라왔습니다. "세종대왕 프로젝트"라는 이름으로 한글코딩 컨벤션에 대한 짧은 문서를 같이 공개했구요. https://tosspayments-dev.oopy.io/chapters/frontend/posts/hangul-coding-convention 세종대왕 프로젝트 (한글 코딩 컨벤션) 한글 코딩? 어려운 도메인 용어에 대해 변수명을 정할 때, 어색한 영어보다 이해하기 쉬운 한글로 짓는 컨벤션을 말합니다.보다 이해하기 쉽고 눈에 잘 들어오는 코드를 작성할 수 있다는 장점 tosspayments-dev.oopy.io 토스에서 코딩에 한글 상수, 변수를 사용한다는 .. WTD 포틀랜드 2023 - 포용적인 언어에 대해 이번 세션 주제는 쉽지 않습니다. 발표자의 개인적인 경험을 담고 있고 여러 논쟁이 있는 주제라 그런 것 같습니다. 그래서 발표 전에 몇 가지 규칙을 미리 공지하고 진행합니다. 해당 규칙에 따라(아마 운영진과 합의된 것이 아닌가 싶습니다) Q&A는 진행하지 않았습니다. 주제는 트라우마와 포용적인 언어에 대한 이야기입니다. 트라우마라는 표현은 많이 들어보긴 했지만 실제 경험한 것이 아니라면 공감하기 쉽지는 않습니다. 한국에서는 2018년 국가트라우마센터가 설치됐습니다. 대형 재난에 대한 심리지원이 체계적으로 필요하다는 필요성 때문이었죠. 국가트라우마센터 사이트에서는 트라우마를 다음과 같이 정의하고 있습니다. https://www.nct.go.kr/itaewon/traumaIntro1.do ...트라우마란 재.. WTD 포틀랜드 2023 - 테크니컬 라이팅에 AI 활용하기 발표자는 Rokt라는 전자상거래 관련 솔루션 회사에서 테크니컬 라이터로 일하고 있습니다. 딱히 AI 관련된 기술에 가까이 있는 것은 아니고 개인적인 관심을 가지고 이런 저런 것들을 찾아보고 시도해보았다고 합니다. AI가 일상적으로 쓰인 것이 최근 일인 것 같지만 사실 검색어 입력 시 자동 완성이라든지 맞춤법 검사, 문법 검사 같은 장치들은 꽤 오래전부터 사용하고 있었습니다. 물론 이러한 것들을 의도적으로 쓰지 않는 분들도 있지만요. 기계 번역도 마찬가지입니다. 어떤 방식을 사용하든 AI가 어느 정도 개입하고 있었던 것들이죠. 테크니컬 라이터가 AI를 통해 얻을 수 있는 이점 - 생산성의 향상(반복직인 작업은 AI에게 맡기고 전체적인 문서 구조화 등 작업에 집중할 수 있음) - 콘텐츠 품질 향상(문법, 맞.. 마이크로소프트 언어 포털이 없어졌어요 예전에는 별도 사이트로 제공이 되었습니다(아래 이미지는 web.archive.org에서 가져온 것이라 스타일 등은 좀 다를 수 있습니다. 뭐 대충 이런 스티일이었습니다). 저는 http://www.microsoft.com/ko-kr/language 링크를 북마크 해놓고 방문하곤 했는데요. 오늘 용어 하나 확인할 것이 있어 사이트를 방문했더니 https://learn.microsoft.com/en-us/globalization/reference/microsoft-language-resources 링크로 연결이 되더군요. 관련 내용을 찾아보니 얼마 전부터 서비스가 중단된다는 공지가 있었다고 하더라구요. 중간중간 링크를 찾아보면 기존 제공하던 용어집, UI 번역, 스타일 가이드 등은 모두 제공하고 있습니다. .. 사서함이 거의 가득 찼습니다 스팸 메일입니다. 스팸 필터를 사용하는 경우에는 대부분 스팸으로 걸러낼 겁니다. 안랩에서도 관련된 내용을 정리한 적이 있네요. https://asec.ahnlab.com/ko/15910/ 메일 사서함 업데이트 위장한 피싱메일 주의!! - ASEC BLOG ASEC 분석팀은 메일 사서함 업데이트로 위장한 악성 메일이 국내에 유포 중인 것을 확인하였다. 사용자 이메일 계정을 포함한 사서함 업데이트 제목으로 유포 중이며, 첨부된 링크를 클릭하도록 asec.ahnlab.com "사서함"이라는 표현 때문에 스팸이다 싶었습니다. "사서함"이라는 것이 흔하게 쓰는 표현이 아니라고 생각했던 거죠. 하지만 그건 저만의 착각이었나 봅니다(사서함으로 편지 보내던 옛날 사람이라 그런가 봅니다). 일단 IT 용어사전에서는 el.. voting check 문서 빌드 시 테스트 항목 중 voting check라는 항목이 있습니다. The tests do not run any grammar or spell checkers because a voting check must always be accurate. 단어의 의미만으로 해석하면 투표를 통해 일정 비율 찬성을 하면 통과하는 건가 싶었는데(같은 문서 내 Voting test라는 표현도 있습니다. 이건 진짜 찬반 투표를 통해 통과하는 테스트) 구글에서 검색을 해보면 위키피디아 "Literacy test"로 연결해 줍니다. https://en.wikipedia.org/wiki/Literacy_test 대충 해석해 보면 1960년대 이전까지 투표를 진행하기 전에 유권자들의 문해력을 테스트하고 통과된 이들에게만 투.. 이전 1 ··· 8 9 10 11 12 13 14 ··· 45 다음
