테크니컬 라이팅/WTD 컨퍼런스 (129) 썸네일형 리스트형 WTD 애틀랜틱 2024 - 누구나, 어디서든 사용할 수 있는 콘텐츠 디자인 발표자의 배우자가 코로나 기간 동안 산책을 나갔다가 개의 습격을 받아 머리의 손상을 입었다고 합니다. 이후 과정에서 활동을 지원해 주는 다양한 도구들을 찾아보면서 접근성에 대해 고민하기 시작했다고 하네요. 접근성에 대한 기본 개념에 대한 설명을 9분까지 진행합니다. 접근성에 대해 어느 정도 알고 있다면 9분 이후부터 시청해도 될 듯합니다. 영상이 발표보다는 홍보 영상 같은 느낌이라서 살짝 이질감이 있긴 합니다. 너무 잘 만든 영상이 주는 부작용이랄까요. 9분 이후부터는 발표자가 속한 기업에서 콘텐츠의 접근성을 검토하면서 어떤 활동을 했는지 설명하고 있습니다. accessScan이라는 유료 서비스를 통해 현재 제공되는 콘텐츠의 접근성을 검토했다고 합니다. 보통은 무료 도구를 사용하는데 전반적인 접근성을 향.. WTD 애틀랜틱 2024 - 문서와 대화하는 방식의 변화 LLM의 간략한 역사와 현재 LLM의 제약(제한된 학습 데이터, 환각 현상)을 설명합니다. 이를 보완하기 위한 수단으로 RAG를 설명합니다. RAG는 2가지 타입이 있습니다. 하나는 벡터 기반 RAG입니다. 유사성 검색을 지원하고 매우 빠르게 동작합니다. 그리고 대규모 문서도 잘 처리할 수 있습니다. 하지만 개념들의 관계를 놓칠 수 있습니다. 특히 긴 문서에서 전체적인 맥락을 잘못 이해할 수 있습니다. 그래서 벡타 기반 RAG를 사용하기 위해서는 문서에 대한 전처리 과정이 중요합니다.또 하나는 그래프 기반 RAG입니다. 지식 그래프와 LLM을 결합해서 벡터 기반 RAG를 보완하는 방식입니다. 벡터 기반 RAG의 단점인 개념 간의 관계를 정의하고 있기 때문에 이를 명확하게 설명할 수 있습니다. 단점은 일단.. WTD 애틀랜틱 2024 - 문서 템플릿의 역사 수잔 암스트롱 링크드인 경력을 보면 1986년부터 테크니컬 라이팅 업무를 시작했습니다. 소프트웨어, 장비, 네트워크 등 다양한 분야를 경험했습니다. 2013년부터는 기술 문서 관련 컨설팅 업무를 수행하고 있다고 합니다. 컴퓨터와 온라인이 등장하기 전에는 대부분 매뉴얼이 일정한 템플릿에 따라 작성됐습니다. 어떤 기술 문서를 보든 어떤 순서로 따라 할 수 있는지 직관적으로 이해할 수 있습니다. 또한 특정 작업을 바로 수행해야 할 때도 있어서 개별적인 과업에 대한 문서도 템플릿에 따라 작성이 되었습니다. 하지만 너무 형식적인 템플릿 때문에 실제 과업을 수행하는데 어려움을 겪었습니다. 1980년대 IBM 등에서 기술 문서에는 필수 정보를 담아야 한다는 미니멀리즘이 언급되었고 이런 경향은 최근까지 이어져오고 있.. WTD 애틀랜틱 2024 - 아직도 워드에서 문서를 작성하고 있나요? Lorna Mitchell은 Redocly에서 테크니컬 라이터로 일하고 있습니다. 소프트웨어 개발자 경험이 있고 기술 서적을 출판한 경험이 있습니다. 이번 강연은 어떻게 보면 낯선 환경에 들어서야 하는 테크니컬 라이터를 위한 강연인데.... 너무 원칙적인 이야기하면 해서 그럼 어떻게 해야하는데라는 질문이 나올 수밖에 없네요. Q&A에서도 언급되었지만, 그건 각자 알아서 공부하라는... DevOps의 간략한 정의 - Dev: 소스 컨트롤, 코드 개발 도구 - Ops: 빠른 피드백, 지속적인 개선 이 강연에서 배운 것을 활용하기 위한 전제 조건 - 기술 문서는 텍스트 기반으로 작성되어야 합니다(예를 들어 마크다운 같은. 텍스트 기반 콘텐츠의 장점은 서식을 설정하거나 맞춤법 검사 등 도구와 연결하는데 매우 .. WTD 포틀랜드 2024 - 라이트닝 토크 둘째날 이전에는 라이트닝 토크를 다 따로 영상을 올렸는데 이번에는 Day 1, Day 2 이렇게 구분해서 여러 명의 발표를 묶어놓았습니다. * August Lindgren-Ruby: Semantic Line Breaks (SemBr)마크다운으로 작성한 문서는 줄 바꿈을 처리하려면 2칸 이상 띄어쓰기를 하거나 한 줄을 추가로 넣어주어야 합니다.때문에 이런 장치 없이 줄바꿈을 하더라도 실제 화면에 표시될 때는 한 줄로 표시가 됩니다. 하지만 파일을 비교해야 할 때 줄 바꿈이 없이 긴 문장은 어느 부분이 수정되었는지 쉽게 인지할 수가 없습니다.그래서 시맨틱한 줄 바꿈을 마크다운 문서에서 활용하면 파일 비교 등의 작업에 도움을 줄 수 있습니다.(영어의 경우에는 쉼표를 좀 많이 사용하는 편인데 한국어는 그에 비해 쉼표.. WTD 포틀랜드 2024 - 라이트닝 토크 첫째날 이전에는 라이트닝 토크를 다 따로 영상을 올렸는데 이번에는 Day 1, Day 2 이렇게 구분해서 여러 명의 발표를 묶어놓았습니다. * Ashley Gordon - How I convinced 105 colleagues to help me Write the Docs내부 문서를 어떻게 개선했는지 공유합니다.개발자들이 정보를 만들어서 던져놓고 다시는 건드리지 않아 썩어가고 있다고 묘사합니다. 그래서 콘텐츠를 체계적으로 관리할 수 있는 솔루션을 구입하고 콘텐츠를 이전해서 개선되기를 바랬는데 전혀 변화가 없었습니다. 그 원인은 "Garbage in, garbage out"이라고 하네요.이를 개선하기 위해 누군가 나서야했는데 아무도 나서지 않아서 본인이 PM을 담당하기로 했다고 합니다.6가지 정도 성공의 요인을 .. WTD 포틀랜드 2024 - 콘텐츠를 의미있게 만들고 활용하기 발표자의 이력은 좀 독특합니다. 오라일리 미디어에서 약 7년간 일을 했고 그 이후 맥밀란 출판사에서 약 3년 정도 일을 했습니다. 콘텐츠 워크플로우 개발 쪽 일을 주로 했던 것 같네요. 그래서 출판 쪽 커리어를 가지고 있지만 스스로 개발자라도 이야기하는 이유이기도 합니다. 최근에는 프리랜서로 일하면서 hederis라는 회사(콘텐츠 출판 관련)도 운영하고 있네요. 콘텐츠의 각 단락은 시맨틱 정보를 포함해야 합니다. 예를 들어 제목 단락에 아무 정보 없이 굵게 12pt로 설정만 한다면 시각적으로는 제목이라는 것을 구분할 수 있지만 시각 장애가 있거나 봇이 접근하는 경우에 이를 구분할 수 없습니다. 워드에서 문서를 작성하는 경우에 그냥 텍스트를 선택하고 서식을 지정하는 것이 아니라 스타일을 적용하도록 권장하는.. WTD 포틀랜드 2024 - 디자인 리뷰를 통해 맥락이 담긴 문서 만들기 Shawn Aldridge는 컴퓨터 사이언스로 학부를 로보틱스로 석사학위를 받고 소프트웨어 엔지니어로 일했습니다. 현재는 데이트앱(Tinder)을 만들고 있습니다. 틴더의 경우 약 300명의 엔지니어가 있습니다. 사용자를 3억명 정도로 계산하면 1명의 엔지니어가 100만 명의 사용자를 담당하게 됩니다(적절한 비유인지는 모르겠으나). 하여간 그래서 1명의 엔지니어가 매우 효율적으로 일해야 하고 이를 위한 재량권을 가지게 된다고 합니다. 대략 40개의 팀(프로젝트)으로 작업을 진행하는데 이 각각의 팀에서 문서를 다루다보니 역시 문제가 발생합니다. 4가지 형태로 문제를 정의할 수 있습니다. - Fragmentation: 서로 다른 문서 플랫폼, 문서 스타일, 작성 프로세스 - Brittleness: 문서에 작.. 이전 1 2 3 4 5 ··· 17 다음
