본문 바로가기
728x90

테크니컬 라이팅

 (310)
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..
2022년 6월 테크니컬 라이팅 이런 저런 소식 6월 3일 Write the Docs Portland 2022 동영상이 공개됐습니다. 12개 세션, 10개의 lightning talk 영상이 포함되어 있습니다. https://www.youtube.com/playlist?list=PLZAeFn6dfHpnDhFvXG8GprqlLlzSQRBui https://www.writethedocs.org/conf/portland/2022/news/thanks-recap/ 에서 그 외 컨퍼런스 관련 정보를 확인하실 수 있습니다. 6월 8일 테크니컬 라이팅 온라인 교육 사이트가 오픈했습니다. 테크니컬 라이팅 교육과 컨설팅 서비스를 제공하는 디앤디에서 카카오 같은 재택 대상 기업에게 제공하기 위한 용도로 시작한 것이 아닌가 싶습니다. 현재는 일반 공개된 교육은 없고 특정..
WTD 포틀랜드 2022 - 문서에서 사용하는 코드를 단위 테스트하는 방법 개인적인 정리 Ben Perlmutter는 MongoDB Realm 문서 팀에서 일하고 있다고 합니다. Realm(렘)은 데이터 동기화 기술을 가진 기업으로 2019년 MongoDB에서 인수했더군요. 2017년부터 MongoDB에서 일을 시작했습니다. 간단하게 Realm이라는 것이 뭔지 설명해주며 시작합니다. 모바일 기기에 데이터를 저장했다가 서버와 동기화해주는 거라고 하네요. 요즘은 거의 모든 기기가 네트워크에 연결된 상태라 그럴 필요가 있나 싶지만 뭐 환경에 따라 그럴 수 있으니. 사이트 설명을 보면 SQLite을 대체하는 솔루션이라고 하네요. https://realm.io/ 문서 내에 포함하는 코드는 주로 사용자가 해당 코드를 복사해서 바로 사용하거나 약간의 수정 후 사용할 수 있게 구성되어 있습니..
WTD 포틀랜드 2022 - AWS 문서화팀 이야기 개인적인 정리 놀랍게도 AWS에서 2020년까지는 문서 작업을 마이크로소프트 워드 기반으로 진행했다고 합니다(일부 팀만 그렇게 했다는 건지 아니면 AWS 전체를 이야기한 건지는 명확하지 않습니다. 하지만 발표자인 Marcia Riefer Johnston가 아마존에 합류한 것이 2019년이고 Integration & Automation 팀으로 옮긴 것이 2020년 3월이라 기존에 문서를 코드처럼 다루거나 자동화하는 프로세스가 없었을 수도 있습니다). 코드 기반으로 문서를 전환한 것은 2020년 중반에 시작한 일입니다. * 개인적으로는 DOCS AS CODE가 정답이라고는 생각하지 않습니다. DOCS AS CODE의 장점을 살릴 수 있는 도구라면 대안으로 선택할 수도 있습니다. 특히 문서를 작성하는 팀이 문..
'사용자 정의'와 '사용자 지정'의 차이 뭔가 정답을 기대하고 오셨다면 먼저 사과드립니다. 일단 아래 번역문을 보겠습니다. 이 연습에서는 사용자 지정 시작 페이지에 DLL 참조를 추가하는 방법을 보여 줍니다. 이 예제에서는 솔루션에 사용자 정의 컨트롤을 추가하고, 사용자 정의 컨트롤을 빌드한 다음 '사용자 지정'과 '사용자 정의'라는 표현이 등장합니다. 원문은 아래와 같습니다. This walkthrough shows how to add a DLL reference to a custom Start Page. The example adds a user control to the solution, builds the user control 'custom'은 '사용자 지정'으로 번역하고 'user'는 '사용자 정의'로 번역합니다. 마이크로소프트 언어..
goormide에서 Markdoc HTML 템플릿 테스트하기 요즘 간단한 도구 테스트 시에는 goormide를 사용하고 있습니다. 무료 계정에서 컨테이너를 5개까지 만들 수 있어서 자주 테스트하는 건 만들어놓고 임시로 테스트하는 것은 만들어서 확인하고 삭제해버리고 있습니다. 이번에는 Markdoc HTML 템플릿 실행을 goormide 환경에서 테스트해보았습니다. 컨테이너 생성 및 환경 설정 Markdoc를 사용하는 방법은 몇 가지가 있는데 HTML 템플릿을 사용하는 방법과 Next.js, React를 사용하는 방법입니다. HTML 템플릿을 사용하는 방법은 좀 원초적이긴 하지만 다른 도구에 대한 기본적인 지식 없이도 사용할 수 있어서 사용해보았습니다. goormide에서 아래와 같이 설정한 후 컨테이너를 생성합니다. (2022. 5. 17. 기준입니다. 옵션은 달..
2022년 5월 테크니컬 라이팅 이런 저런 소식 5월 4일 디앤디에서 진행하는 'B2B 국문 테크니컬 커뮤니케이션 공개 교육' 안내입니다. 6월 2일 하루 진행되는 교육이구요. 오랜만에 오프라인으로 진행됩니다. 'B2B'라는 문구는 크게 신경 쓰지 않아도 됩니다. B2B 국문 테크니컬 커뮤니케이션 공개 교육 비슷한 내용으로 TTA에서 6월 20일부터 3일간 테크니컬 라이팅 교육이 진행될 예정입니다(이건 5월 23일부터 등록이네요). 강사가 같은지는 모르겠습니다. 예전에는 장현아 대표가 직접 진행했는데 요즘에는 다른 강사를 보내기도 하더라구요. 2022년 제1차 SW 글로벌화를 위한 국‧영문 B2B 테크니컬 라이팅 교육 5월 11일 어제(5/10) 출간된 신간 소개입니다. '구글 엔지니어는 이렇게 일한다 Software Engineering at Goo..
반응형

티스토리툴바