본문 바로가기
728x90

테크니컬 라이팅

 (308)
도큐사우루스에 문서 추가하기 (3) 폴더에 따라 페이지와 문서가 구분 이전 "페이지 추가하기"를 설명하면서 가장 큰 차이는 사이드바를 가지는지 여부라고 했는데 그 외에도 하단 페이징 영역이라든지 버전 관리 지원 등의 차이가 있습니다. 문서를 추가하는 방법은 페이지와 같습니다. 다만 어느 폴더에 파일을 만드는지에 따라 달라집니다. 페이지는 "src/pages"라는 폴더에 넣고 해당 도메인 루트에서 접근을 했는데 문서는 "docs" 폴더에 넣습니다. 그리고 접근할 때도 domain.com/docs/hello 이런 식으로 docs/ 경로 아래로 접근하게 됩니다. 사이드바 사이드바는 docs 폴더에 있는 파일 기준으로 자동 생성됩니다(기본 옵션이 그렇게 되어 있습니다). 루트에 있는 sidebars.js 파일을 보면 자동으로 설정되어 있는 코드를..
WTD 포틀랜드 2022 - 바닥부터 문서 팀 만들기 개인적인 정리 Lana Brindley는 Timescale의 문서 관리자라고 합니다. Red Hat, OpenStack, SUSE 등 다양한 기업을 거쳐 Timescale에는 2021년 합류했습니다. Timescale은 시계열 데이터에 대해 SQL을 확장하고 분석하는 도구라고 합니다. 2018년 시작한 회사이고 이쪽 분야에서는 독보적인 기술을 보유한 듯합니다. 앞에서 화려한(?) 경력을 가지고 있다고 설명했는데 정확하게 어떤 회사인지는 말하지 않지만 이 정도 규모의 문서 팀에서 일했다고 합니다. (1) 4명에서 시작해서 14명까지 (2) 2명에서 시작해서 9명까지 (3) 오픈소스 커뮤니티 (다수명) (4) 1명에서 시작해서 2명 (스타트업. 회사 망함) (5) 1명에서 시작해서 현재 3명(Timescal..
로딩중 또는 로드중 "로딩중"이라는 표현을 별생각 없이 사용하고 있었는데 이게 load+ing라서 겹말이 될 수 있다는 글을 봤습니다. 나무 위키에서도 아래와 같은 설명이 있네요. 'Loading'은 '싣다'라는 뜻의 load의 현재진행형이기 때문에, 한글 음차하면 '로딩 중'이 아닌 '로드 중'이라고 하는 것이 맞다. 다만 현재진행형이 아니라 load의 명사형으로 loading을 사용하는 것이라면 '로딩 중'이 맞다고 할 수도 있긴 하다. load의 명사형은 그냥 load라고 반박할 수도 있으나 그냥 load에는 '프로그램을 불러오는 과정'이라는 뜻은 없다. 국립국어원에서도 관련 답변을 남기긴 했는데 "로드"라는 단어는 사전에 등재되지 않았고 "로딩"이라는 단어로 등재되어 있어서 "로딩 중"이라고 쓰면 문제가 없다는 답변..
도큐사우루스에 페이지 추가하기 (2) 도큐사우루스 페이지와 문서 도큐사우루스에서는 문서와 페이지를 구분해서 설명합니다. 가장 큰 차이는 사이드바를 가지는지 여부입니다. 사이드바는 문서 왼쪽에 전체 목차처럼 표시되는 영역입니다. 문서는 책 형태를 표현하는 것이기 때문에 전체 목차를 가지고 있습니다. 페이지는 전단지처럼 별도의 목차 없이 한 페이지에 정보를 담습니다. 도큐사우루스에서는 이벤트 페이지처럼 문서와 직접 상관이 없는 항목들을 만들 때 페이지를 사용할 수 있다고 설명합니다. 도큐사우루스 사이트에서도 "쇼케이스"에 들어가면 사이드바가 표시되지 않습니다(점점 콘텐츠가 늘어나서 적절한 목차가 있어야 하지 않을까 싶긴 하지만). 상단에 필터가 있어서 원하는 콘텐츠를 필터링하는 기능을 제공하지만 사이드바에서 별도의 목차를 제공하지는 않습니다. ..
WTD 포틀랜드 2022 - 테크니컬 라이터 온보딩 프로그램으로 짝 글쓰기 활용하기 개인적인 정리 Chris Ganta는 아틀라시안 테크니컬 콘텐츠 디자이너입니다(하는 일을 보면 테크니컬 라이터와 다르지 않은데 디자인 조직 내 속하다 보니 그렇게 이름을 붙이는 것이 아닌가 싶네요). 아틀라시안에는 올해 1월 합류했고 이전에는 다양한 기업에서 테크니컬 라이터로 활동했습니다. Peer writing - "Two Heads are Better than One". And we got more than two Anyone can fall into a creative rut from time to time, but it is rare for two people to do so concurrently. 오픈소스 프로젝트에서 전문적인 테크니컬 라이터가 아닌 이들이 어떻게 문서화 작업에 성공적으로 안착..
도큐사우루스 설치하고 튜토리얼 실행하기 (1) 지난번에는 goormIDE에서 Markdoc을 설치해보았는데요. https://koko8829.tistory.com/2290 이번에는 도큐사우루스를 다루어보겠습니다. 우선 설치하고 실행하는 것까지 진행합니다. 컨테이너 생성 및 환경 설정 도큐사우루스는 Node.js 16.14 이상 버전을 필요로 합니다(2.0.0-beta.21 기준). 때문에 goormIDE에서 컨테이너 생성 시 소프트웨어 스택은 Node.js로 선택하고 추가 모듈/패키지 항목에서 "Node.js 버전 16.x로 업데이트"를 선택해야 합니다(현재 시점에서는 16.15.1로 설치합니다). 도큐사우루스 설치 도큐사우루스 공식 문서 내 "패스트트랙"이라는 항목이 있습니다. 뭐 딱히 별 내용은 없고 최초 도큐사우루스 최신 버전을 설치하고 튜토리..
WTD 포틀랜드 2022 - 구글은 문서를 어떻게 평가할까? 제목은 낚시였습니다. 정확하게 이야기하면 평가 지표 등은 오픈소스 프로젝트 조직에서 결정하는 것이고 구글은 이를 지원하는 역할만 하는 거라서~~ 개인적인 정리 Season of Docs 프로그램은 2019년 시작됐습니다. 그때는 테크니컬 라이터 Sarah Maddox와 오픈소스 담당자 Andrew Chen가 진행을 했었다고 합니다. https://opensource.googleblog.com/2019/03/introducing-season-of-docs.html 초기에는 오픈소스 운영자에게 좋은 문서를 더할 수 있는 기회를 제공하고 테크니컬 라이터에게는 오픈소스 프로젝트에 참여할 기회를 주는 것이죠. 운영 방식 아이디어는 Summer of Code에서 가져왔는데 Summer of Code는 멘토링에 초점..
WTD 포틀랜드 2022 - Runbook과 기술 문서는 무슨 차이가 있을까? 개인적인 정리 Shane Diven는 2018년부터 Alastair Dallas는 2019년부터 Splunk에서 테크니컬 라이터로 일하고 있습니다. Splunk는 2003년 설립되어 7500명 정도가 일하고 있는데 사용자의 플랫폼을 24시간 모니터링하는 서비스를 제공하는데 문제가 생겼을 때 내부 엔지니어는 Runbook을 참조해 대응하게 됩니다. 그래서 오늘의 주제는 "Runbook"입니다. 한국어로는 적당한 번역이 없는데 IT용어대사전에서는 "실행서"라고 표현하고 있네요. 프로세스 자동화에서는 Runbook을 작업 시나리오의 의미로 사용하고 있는데 이번 세션에서는 실제 작업자가 수행해야 하는 작업 가이드라고 이해하면 될 듯합니다. 이번 세션은 이런 테크니컬 라이터를 위한 내용으로 구성했다고 합니다. A..
반응형

티스토리툴바