본문 바로가기
728x90

테크니컬 라이팅

 (310)
WTD 포틀랜드 2022 - 문서 통계를 믿지 마세요 개인적인 정리 Kumar Dhanagopal은 오라클에서 13년간 기술지원, 테크니컬 라이팅, 커뮤니티 업무를 담당했고 2021년 구글로 자리를 옮겨 현재는 솔루션 라이터라는 업무를 맡고 있습니다. 이게 솔루션 라이터라고 해서 뭔가 특별한 건 아니고 소속 조직에 따라 이름이 다른 것 같네요. https://careers.google.com/jobs/results/92138733240754886-technical-writer-cloud-industry-solutions/?jlo=en_US 이번 세션에서는 구글 애널리틱스에 대한 이야기인데요. 구글 테크니컬 라이터가 이야기하는 것이니 뭔가 숨겨진 팁도 공개를 하지 않을까 싶습니다(물론 세션 발표에 대한 내용은 개인적인 의견이며 구글의 공식적인 의견은 아니라고..
Technical Writer HQ에 대해 페북에 올라온 게시물 중 Technical Writer HQ 유튜브 영상에 대한 링크가 있었습니다. 아마존, 메타, 레드햇 등의 테크니컬 라이터와의 인터뷰와 함께 테크니컬 라이터에 대해 궁금한 몇 가지 정보를 알려주는 영상이 올라와있더군요. 구독자는 대략 2900명 정도이고 가장 많은 조회수는 1만 회입니다. 채널 소개 정보를 보면 Technical Writer HQ is building the world’s most trusted resource for technical writing. 라고 설명하고 있는데 기술 문서에서 금지(?)하고 있는 "world’s most" 같은 근거 없는 문구를 사용하는 걸 보면 이 채널은 뭔가 의심스럽네요. 유튜브 채널은 다시 https://technicalwriterhq..
도큐사우루스에서 블로그 운영하기 (5) 개인이 문서 도구를 사용할 때는 대부분 개인 블로그를 운영하기 위한 경우가 많습니다. 네이버 블로그를 써도 되지만 뭔가 자유롭지 못하고 티스토리나 워드프레스는 어느 정도 수정을 할 수 있지만 그럼에도 제약이 있어서 불편합니다. 물론 도큐사우루스 같은 문서 도구를 사용하더라도 원하는 대로 꾸미려면 많은 수고가 필요해서 대부분 기본 템플릿 정도로만 사용하긴 합니다만~ (뭐 정 마음에 들지 않으면 직접 개발해야죠~). 기본 템플릿에서 블로그 만들기는 간단합니다. 사실 이미 만들어져 있고 그냥 새로운 포스트만 추가하는 겁니다. blog 폴더 아래에 YYYY-MM-DD-제목 형식으로 파일명을 만들면 끝입니다. 파일명에 있는 날짜를 기준으로 새로운 글이 추가되고 화면에 표시됩니다. 끝. 날짜 폴더에서 블로그 포스트..
WTD 포틀랜드 2022 - 콘텐츠 재사용 시 유의할 점은 어떤 것이 있나요? 개인적인 정리 Anna Gasparyan는 JetBrains 입사 8년 차입니다. 테크니컬 라이터로 시작해서 2020년부터는 PM을 담당하고 있습니다. 자신의 이력을 모자로 표현한 일러스트가 인상적입니다. 테크니컬 라이터 경력은 약 15년이라고 합니다. (내부 문서 작성 및 배포 시스템 개발을 담당하고 있는 듯 한데 상용으로 공개된 제품인지 내부에서 쓰는 것인지 명확하지는 않습니다). (Writerside라는 제품을 준비하고 있네요. 아직은 공개전이긴 합니다). https://lp.jetbrains.com/writerside/ JetBrains은 다양한 언어와 기능을 지원하는 개발 도구를 만들고 있는데요. 각 개발도구는 공통적인 기능이 있고 특화된 기능이 있습니다. 12개의 개발 도구를 만든다면 문서 역..
Storyblok 체험해보기 (4) Structures of Content https://www.storyblok.com/docs/guide/essentials/content-structures 의 내용을 요약한 겁니다. Getting Started에서 용어에 대한 설명이 바로 나오면서 자세한 내용은 이 문서를 참고하라고 하죠. 하지만 이미 용어가 나오는 순간 이게 무슨 이야기지 싶어서 Getting Started를 보기 전에 이 문서를 먼저 보거나 같이 보는 것이 좋을 듯합니다. 제목은 Structures of Content이지만 그냥 각 용어에 대한 개념 설명입니다. 콘텐츠 구조와 연결되어 있긴 하지만 전체 구조가 딱 쉽게 이해되지는 않네요. 다루는 용어는 아래와 같습니다. Account 같은 건 다른 서비스와 딱히 별 다른 것이 없어서 여기서 설명을 했어야 했나 싶기도 합..
Storyblok 체험해보기 (3) Getting Started https://app.storyblok.com/beta-v2 기준으로 작성했습니다. 공개된 문서는 하나인데 v1 문서는 더 이상 접근할 수 없고 v2 기준 문서만 보이고 있습니다. (https://web.archive.org/ 에서 확인해보면 올해 1월까지는 v1 문서가 보이는데 그 이후에 변경된 것이 아닌가 싶네요). https://www.storyblok.com/docs/guide/getting-started 의 내용을 요약한 겁니다. 스페이스 만들기 새로운 스페이스를 만들거나 데모 스페이스를 만들 수 있습니다. Use a blueprint는 라이브러리에서 템플릿을 선택하는 것이라고 하는데 아직 미공개된 기능입니다. 새로운 스페이스를 만들면서 서버도 설정할 수 있나 봅니다. 역시 아직 미공개된 기능입..
Storyblok 체험해보기 (2) 소개 문서 읽기 https://www.storyblok.com/docs/guide/introduction 의 내용을 요약한 겁니다. 아직 세부적인 내용을 보지 않아서 소개 문서만으로 이해하지 못하는 부분들도 있습니다. 사용자의 문제일 수도 있지만 일반적으로 소개 문서는 개발자, 디자이너, 기획자 등 다양한 배경을 가진 이들이 본다는 측면에서 좀 더 친절해야 하지 않았을까 싶긴 합니다. 기술 문서의 첫 번째는 어떤 카테고리에 속하는지 그러면서 어떤 특징을 가지고 있는지 설명하는 겁니다. 일단 Storyblok은 Headless Content Management System 카테고리에 속하면서 유일하게(only) 비주얼 에디터를 지원한다고 합니다(유일하다는 건 사실 언제든지 바뀔 수 있는 거라 위험한 표현이긴 합니다만). ..
CCMS Storyblok 체험해보기 (1) 회원가입 간혹 외국계 기업에서 테크니컬 라이터 모집 시 CCMS 스킬을 요구하는 경우가 있습니다. CCMS는 Component Content Management System의 약자로 기존 CMS를 좀 더 세분화한 것이 아닌가 싶습니다. 컴포넌트 단위로 콘텐츠를 만들고 조립해 배포한다는 컨셉입니다. 소프트웨어 리뷰 사이트 g2.com에서 TOP 10 사이트와 그 외 사이트를 소개하고 있습니다. (TOP 10 이라는 것이 리뷰 기준인데 CCMS은 사실 리뷰가 별로 없어서 순위가 큰 의미가 없긴 합니다). Storyblok Sanity Adobe FrameMaker Paligo GraphCMS Author-It Documentum Xyleme Heretto Ibexa DXP (formerly eZ Platform En..
반응형

티스토리툴바