테크니컬 라이팅 (353) 썸네일형 리스트형 WTD 프라하 2022 - 질문의 기술 Jeff는 strongdm이라는 액세스 관리 솔루션 업체의 테크니컬 라이팅 팀을 담당하고 있습니다. 웹 개발로 시작해서 2016년부터 테크니컬 라이팅 업무를 시작했습니다. 웹 개발은 독학으로 시작했고 직장에 다니면서 프리랜서로 웹 개발, 기술 글쓰기 등을 해왔다고 합니다. 3가지 키워드를 가지고 질문하기에 대해 설명합니다. 발표자가 뭔가 쉬지 않고 계속 말하는 스타일이라 많은 이야기를 해서 잘 정리가 되질 않네요. Confidence(자신감) - 질문하는 것을 미안해하지 마세요. - Technical writers often report high percentages of imposter syndrome in the workplace. 이건 좀 이해하기 어렵긴 한데 가면 증후군보다는 자신감의 문제라고 생.. WTD 프라하 2022 - 독자와 관계 구축을 통해 문서 개선하기 문서 이해관계자(독자)와의 관계 구축을 통한 콘텐츠 개선하기가 주제입니다. Taylor는 Splunk에서 테크니컬 라이터로 일하고 있습니다. 4년 전 어떤 문서를 개선한 경험에 대해 이야기를 시작합니다. 기존 문서는 뭔가 불편함이 있었다고 합니다(정확하게 어떤 문제였는지는 언급하지 않고 있습니다). 그래서 이런 피드백을 수용하고 개선하기로 결정하고 PM과 어느 정도 범위에서 진행을 할지 협의했다고 합니다. 아래와 같은 점을 수정했습니다. - 태스크 기반 가이드 문서 작성 - 문서, SDK, 예제 저장소에서 사용하는 용어 표준화 - 개발자가 활용할 수 있는 도구, 리소스 소개 - 업데이트되지 않고 정확하지 않은 콘텐츠 제거 프로젝트의 결과로 - 정확하고 최신 코드에 맞는 가이드 문서를 작성했고 - 여러 곳.. WTD 프라하 2022 - Aiven에서는 Lint를 어떻게 사용하나요 Tony Ibbs는 Aiven에서 개발자 교육을 담당하고 있습니다. Aiven는 오픈 소스 클라우드 데이터 플랫폼이라고 하네요. 국내에는 잘 알려지지 않은(검색해 보았을 때) 핀란드 회사입니다. 작년 프라하 컨퍼런스에서는 세션은 담당하지 않고 라이트닝 토크에서 아포스트로피 사용에 대한 짧은 이야기를 전했었네요. 슬라이드를 공개해놓았습니다. 뭐 길지 않은 슬라이드이긴 하지만 ^^ https://github.com/tibs/beyond-spellchecking-talk 문서를 검토하는 가장 좋은 방법은 동료 검토자가 있어서 검토를 요청할 수 있는 것입니다. 하지만 그렇지 않은 경우가 많죠. 조직 내에서 혼자만 문서 업무를 담당하고 있을 수 있고 검토 요청을 하기에는 다들 서로 바쁜 경우엔 그렇죠. 그래서 그.. WTD 프라하 2022 - 마케팅팀과 문서팀이 사이좋게 지낼 수 있을까요 Mano Toth는 오스트리아의 PSPDFKit라는 PDF 솔루션 기업에서 테크니컬 라이터로 일하고 있습니다. 독특하게 케임브리지에서 박사 학위를 받았는데 테크니컬 라이터로 일하고 있습니다. 주제가 마케팅으로서의 문서화인데, 문서 특히 기술 문서에서는 마케팅적인 요소를 가능한 배제합니다. 마케팅은 사실과 완전히 다르지는 않지만 뭔가 사람들을 혹하게 하는 문구들을 사용하는데 그런 부분들 때문에 테크니컬 라이터는 마케팅과 어느 정도 거리를 두고 있습니다(하지만 이건 그럴 것이다라고 대부분의 사람들의 머릿속에 있는 것이죠). Mano는 마케팅과 문서가 서로 갈등 관계에 있다는 증거 중 하나가 대부분의 기술 기업 웹사이트가 문서 사이트와 통합되지 않았다는 겁니다. 기업 웹사이트는 화려하고 SEO를 적용한 반면 .. WTD 프라하 2022 - 밑바닥에서부터 문서팀 만들기 Karissa Van Baulen은 웹사이트 분석 소프트웨어를 만드는 Hotjar에서 기술지원, 콘텐츠 개발, 사용자 교육 등의 업무를 담당하고 있습니다. 현재는 사용자 교육팀 리더라고 합니다. 테크니컬 라이터로 일한 것은 대략 5년 정도 되었구요. 2017년에는 지원팀 전체가 7명이었고 관리하는 문서는 107개였다고 합니다. 이 때는 문서의 소유자가 명확하지 않아서 문서 유지 관리가 제대로 되지 않았던 시기였습니다. Karissa가 기술지원 조직으로 입사를 한 것이 2017년 4월이었는데 이런 상황을 참지 못하고 문서 담당자가 되기로 했다고 합니다. 그 이전 경력을 보면 디자이너, 제품 매니저 등의 업무를 담당했지만 테크니컬 라이터로서 일한 적은 없습니다. 좀 독특한 케이스네요. 그런 결심을 하고 당연.. 2022년 9월 테크니컬 라이팅 이런 저런 소식 9월 2일 postman에서 사용자를 대상으로 진행한 설문 결과입니다. 올해는 6월부터 7월까지 진행하고 8월 중순에 결과를 공개했습니다. 개발자들이 API를 사용하는 비중이 2020년 40%에서 2022년 51%로 늘어났고 경기는 불안하지만 API에 대한 투자는 늘어날 것으로 예측하고 있습니다. 문서화 관련된 몇몇 수치가 있는데 그중 "Improving API documentation"의 결과가 살짝 달라졌습니다. 2020, 2021년에는 Better examples, Sample code에 대한 요구가 많았는데 2022년에는 Up-to-date documentation이 1위를 차지했습니다. API가 만들어지고 사용하는 일이 많아지면서 그에 대한 적절한 문서화가 동반되지 못한 결과가 아닌가 싶네요. .. WTD 프라하 2022 - 문서화를 가로막는 6가지 것들 Emilia Juda Özbay는 블룸버그 테크놀로지 엔지니어입니다. 사내 개발자를 위한 개발도구를 만들거나 지원하는 업무를 담당하고 있어 문서화 도구도 마찬가지입니다. 블룸버그 테크놀로지에서 기존 자바스크립트 기반 환경을 타입스크립트로 변경하기로 결정했습니다. 코드 전환은 물론 배포 환경까지 바뀌어야 하는 커다란 인프라 변경이었지요. 이왕 바꾸는 김에 문서화 시스템도 같이 변경하기로 하고 현재 시스템의 pain point 6가지를 조사합니다. (정확하게는 조사한 건 아니고 이런 저런 자료들을 참고해서 6가지를 선정한 것 같습니다. 참고한 자료는 이런 것들입니다). - Library Evaluation Rankings 자바스크립트 라이브러리 선택 시 어떤 것을 먼저 보는지에 대한 질문인데 1위가 Doc.. 심심한 사과? 깊은 사과? "심심한"이라는 단어는 국립국어원에서 "깊은"이라는 표현으로 다듬고 이를 알리고 있습니다. "심심한 사과"가 아니라 "깊은 사과"라는 표현이 적절합니다. 다듬은 말 중 일부가 좀 어색한 표현이 많아 신뢰를 받지 못하는 면도 있지만 "심심한"의 경우는 일본어투에 대해 다듬은 말이기 때문에 다듬은 말을 사용하는 것을 권장합니다. 네이버 뉴스 라이브러리에서 검색해보면 "심심한"이라는 표현은 1928년 10월 3일 동아일보에 처음 등장합니다. 그 이후에는 꽤 많은 기사에서 등장하는 표현입니다. 신문에 실린 내용이니 누군가 이런 표현을 계속해서 사용하고 있다는 것이죠. 기사에 처음 등장한 시기를 보면 "심심한"이라는 표현이 일본에서 들어온 것이 아닐까 생각해볼 수 있습니다. "사쿠라 훈민정음 : 국어사전 속 숨은.. 이전 1 ··· 15 16 17 18 19 20 21 ··· 45 다음
