본문 바로가기
728x90

테크니컬 라이팅

 (353)
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..
도큐사우루스 사이드바 순서는 어떻게 정해지나 (4) 튜토리얼 기본 옵션은 자동 생성인데 새로운 파일을 추가하면 항상 기존 폴더 뒤에 생성이 됩니다. sidebar_position 그 비밀은 프런트 매터에 설정한 sidebar_position 값에 있습니다. intro.md 파일의 sidebar_position 값이 1이라서 "Turorial Intro" 항목이 가장 먼저 표시되는 겁니다. md 파일 내 프런트 매터 설정이 없으면 파일명 또는 폴더명 알파벳 순으로 표시됩니다. (제목을 설정하면 사이드바에 제목이 표시되는데 그렇다고 해서 제목에 따라 순서가 달라지는 건 아니네요. 순서는 파일명을 따라갑니다). * 프런트 매터에서 설정할 수 있는 값은 아래 링크를 참고하세요. sidebar_position 속성값은 자동 생성된 사이드바 아이템의 경우 유효한 값..
WTD 포틀랜드 2022 - 혼자 일하다가 우울해지면 어찌하나요? 개인적인 정리 Kate Mueller는 KnowledgeOwl에서 Product & Customer Champion으로 일하고 있습니다. Champion이라고 해서 마이크로소프트 MVP 같은 커뮤니티인가 싶었는데 뭔가 이 회사는 스탭 이름을 각자 맘에 드는 방식으로 붙이는 듯합니다. 세션 제목이 Beating the Virginia Blues: Thru-hiking strategies for your next big project인데 일단 2가지 용어가 낯선 것이라 ~ 이에 대한 설명을 한참 합니다. 뭐 그런 거 다 아는 거다 싶다면 7분 정도부터 보세요. Thru-hiking은 종주 하이킹이라고 번역하는데 몇 달에 걸쳐 하이킹을 하는 것이라고 하네요. 종주 하이킹을 위한 코스가 여러 가지가 있는데 그중..
도큐사우루스에 문서 추가하기 (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에는 '프로그램을 불러오는 과정'이라는 뜻은 없다. 국립국어원에서도 관련 답변을 남기긴 했는데 "로드"라는 단어는 사전에 등재되지 않았고 "로딩"이라는 단어로 등재되어 있어서 "로딩 중"이라고 쓰면 문제가 없다는 답변..
반응형

티스토리툴바