테크니컬 라이팅 (310) 썸네일형 리스트형 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일 동아일보에 처음 등장합니다. 그 이후에는 꽤 많은 기사에서 등장하는 표현입니다. 신문에 실린 내용이니 누군가 이런 표현을 계속해서 사용하고 있다는 것이죠. 기사에 처음 등장한 시기를 보면 "심심한"이라는 표현이 일본에서 들어온 것이 아닐까 생각해볼 수 있습니다. "사쿠라 훈민정음 : 국어사전 속 숨은.. 2022년 8월 테크니컬 라이팅 이런 저런 소식 8월 5일 codenary라는 사이트를 이제야 알았네요. 각 기업에서 어떤 기술 스택을 사용하는지 알아볼 수 있는 사이트입니다. SK플래닛에서 공유한 글을 보면 기업에서 자료를 제출하면 기술 스택 정보를 제공하는 형식인 듯합니다. https://www.facebook.com/README.SKP/posts/pfbid0xnLkzxkC89nQeWchtmdsWd4WQ5ExNwzvN8b4QaeTvKGNgGKgzkiRZFWR5jQD1Qd7l 문서화 도구 관련해서도 찾아보았는데요. 아무래도 nextjs 같은 도구는 꼭 문서화에만 사용하는 것이 아니라서 꽤 많은 기업에서 사용하고 있습니다. docusaurus 같은 경우에는 1곳에서만 사용한다고 등록을 했구요. https://www.codenary.co.kr/techs.. 7월 우아한테크세미나 - 개발자도 글을 잘 써야 한다고요?! 리뷰 확실하게 데브렐 팀이 진행하는 테크세미나는 뭔가 활력이 넘치네요. 최근에 슬랙에서 진행한 세미나도 그렇고 이번 세미나도 그렇구요. 세미나 내용을 정리한 건 아니고 중간중간 개인적인 메모로 남긴 내용입니다. 전체 내용은 공개된 영상을 참고하세요. 글쓰기에 진심인 우아한 형제들 우아한 형제 기술 블로그의 월 평균 조회수 15만 회 이상이라고 합니다. (생각보다 조회수가 많지는 않네요. 일 평균으로 보면 5천 회 정도라서 좀 괜찮은 개인 기술 블로그랑 비슷한 수준인 듯합니다.) 그룹별 글쓰기 모임도 가지고 있음(데브렐팀과 테크니컬 라이터 코치가 같이 참여) 개발자는 지식노동자! 지식의 공유가 곧 기술 커뮤니티를 향한 공헌이자 개인역량과 영향력의 강화입니다. 글쓰기를 통해 지식의 공유를 더 활발히 하고 우아한형.. 2022년 7월 테크니컬 라이팅 이런 저런 소식 7월 4일 AWS 일부 문서에는 "기여자(Contributors)" 항목이 있습니다. 테크니컬 라이터뿐 아니라 문서 작성에 관여한 컨설턴트, 엔지니어의 이름이 기록됩니다(주로 백서 성격의 문서인 경우에 항목이 있습니다). 내부적으로는 버전 관리를 하면서 누구누구가 해당 문서를 작성하고 검토했는지 알 수는 있겠지만 이처럼 외부에 문서 작성에 기여한 이들의 이름을 표기하는 방식도 신선하네요. https://docs.aws.amazon.com/ko_kr/prescriptive-guidance/latest/security-reference-architecture/contributors.html 7월 5일 아마존 웹 서비스의 테크 에반젤리스트 윤석찬 님의 글입니다. 아마존에서의 글쓰기 문화에 대한 이야기는 많이 .. 이전 1 ··· 10 11 12 13 14 15 16 ··· 39 다음
