테크니컬 라이팅/WTD 컨퍼런스 (117) 썸네일형 리스트형 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: 문서에 작.. WTD 포틀랜드 2024 - 내부 기술 문서는 어떻게 관리하나요? 스트라이프는 2010년 시작해서 몇 년 동안 작은 규모(수 백 명 수준)의 스타트업이었습니다. 2016년부터 회사의 규모가 커지고 제품도 늘어나게 됩니다. 특히 코로나 기간 동안 온라인 상거래가 늘어나면서 스트라이프 사용자 역시 빠르게 늘어나게 됩니다. 조직이 성장하면서 내부 문서에 대한 불만이 커져갔습니다. 이전에는 누가 어떤 작업을 했고 어떤 문서가 어디있는지 알 수 있으니 큰 문제가 아니었는데 조직이 커지면서 점점 문제로 자리 잡았습니다. 스트라이프에서는 2년에 한 번씩 내부 개발자를 대상으로 설문을 진행합니다. 어떤 것이 개발에 방해가 되는지 확인하기 위한 용도입니다. 설문 결과 내부 문서에 대한 불만이 많음이 드러났습니다. 불만을 몇 가지로 정리해 보면 다음과 같습니다. - Fragmentati.. WTD 포틀랜드 2024 - 스토리 포인트 기반 문서 평가하기 발표자는 포틀랜드에서 Dutchie라는 회사의 테크니컬 라이터로 일하고 있습니다. 여기는 대마초 스타트업입니다. 2021년도 기사를 보면 대마초 관련 스타트업 중에서 처음으로 1조 가치를 넘었다는 이야기가 있네요. 대마초 관련 산업이 얼마나 큰지 알 수 있는 소식이죠. 실제 이전 테크니컬 라이터 인턴 인터뷰에서도 대마초 관련 기업에서 인턴을 했다는 이야기도 있었습니다. 2021.05.28 - [테크니컬 라이팅] - 테크니컬 라이터 인턴은 어떤 일을 할까? 테크니컬 라이터에게 평가나 측정은 쉽지 않은 도전입니다. 수치화된 결과를 만들기 어렵기 때문에 주관적인 접근을 사용하기도 하지만 말 그대로 주관적이기 때문에 일관성 있는 결과를 만들기 어렵습니다. 때문에 어떤 하나의 프레임워크를 정하고 이에 따라 평가하.. WTD 포틀랜드 2024 - OpenAPI 도입 가이드: 테크니컬 라이터를 위한 4단계 OpenAPI를 사용하기로 했다면 다음 4가지 단계를 따르는 것을 권장합니다(물론 발표자의 개인적인 의견이므로 절대적인 것은 아닙니다). 1. 새로운 문서 만들기(New documentation) 일반적으로 OpenAPI 문서화를 처음 접하는 이들이 가장 어려워하는 부분입니다. 일반 문서로 작성된 내용을 컴파일할 수 있는 OpenAPI로 옮기는 부분이죠. 특히 테크니컬 라이팅에 익숙한 이들이 더 어려워합니다. 왜냐하면 OpenAPI는 테크니컬 라이팅보다는 코딩에 가깝기 때문이죠. 때문에 테크니컬 라이터처럼 생각하지 말고 개발자처럼 생각해야 합니다. 아래 이미지의 경우 accountValue라는 필드값이 필수인데 입력할 수 있는 문자 길이 범위는 0~50으로 초안이 작성되어 있습니다. 이 두가지 내용은 서.. WTD 포틀랜드 2024 - 문서화 프로세스를 위한 교과서적인 가이드 발표자는 스타트업에서 경험하는 복잡한 문서화 경험을 마치 엉킨 이어폰줄에 비교합니다. 금방 해결될 것 같지만 자꾸만 꼬여버리지요. 그래서 이를 풀어낼 수 있는 방법을 안내하는데 너무 교과서적인 이야기를 합니다. 분명 주제는 스타트업이고 이런 걸 다 챙길 여력이 없을 텐데 말이죠. 이 분 커리어를 보면 최근 테크니컬 라이팅 분야 컨설팅을 같이 하고 있습니다. Fabric이라는 기업에서 일하면서 개인적으로 컨설팅도 같이 하는 듯합니다. 그래서 그런지 뭔가 발표 내용은 컨설팅 자료에 적합한 그런 내용이네요. 좀 더 구체적으로 활용할 수 있는 템플릿이었으면 어떨까 하는 아쉬움이 남네요. 발표 내용 중에 인상적인 그림이었는데 자세하게 다루지는 않고 그냥 넘어가서 좀 아쉽네요. Q&A에서 규모가 좀 더 큰 조직이나.. 이전 1 2 3 4 ··· 15 다음
