테크니컬 라이팅 (353) 썸네일형 리스트형 ChatGPT를 활용한 B2B 테크니컬 라이팅 교육 후기 지난 6월 3일 한국정보통신기술협회에서 "ChatGPT를 활용한 B2B 테크니컬 라이팅" 기본 과정을 수강했습니다. 과정은 다음과 같이 구성됐습니다. 기본적인 테크니컬 라이팅 개요와 ChatGPT 활용으로 구분되어 있습니다. 교육 참석자들이 기술 문서를 작성한 경험이 있는 분들만 참석하는 것이 아니라서 업종이나 직군에 상관없이 교육을 듣고 활용할 수 있습니다. - B2B 테크니컬 라이팅의 핵심 확인하기 - ChatGPT 사용 전 필수 개념 확인하기 - ChatGPT를 사용하여 기술 문서 작성하기 - 기술 문서 작성을 위한 주요 프롬프트 작성 가이드라인 - Demo: ChatGPT를 사용한 기술 문서 작성 강사는 디앤디의 장현아 대표 컨설턴트입니다. 디앤디에서는 주로 개별 기업 단위로 테크니컬 라이팅 강.. 2024년 8월 테크니컬 라이팅 이런 저런 소식 8월 8일Stack Overflow 개발자 설문조사 2024https://survey.stackoverflow.co/2024/질문 중에 "How do you learn to code?"라는 질문이 있는데 응답자의 82%가 온라인 리소스를 선호한다고 합니다. 중복 답변이 가능하기 때문에 다른 항목도 선택할 수 있는데 종이책은 50%입니다.그럼 온라인 리소스를 어떻게 활용하느냐에 대한 질문(What online resources do you use to learn to code? )에 대해 응답자 83%는 기술 문서를 참고한다고 합니다. 독특한 것은 AI의 도움을 받는다는 답변이 37%나 된다는 것이죠. Learning to code 질문은 2022년부터 추가되었는데요. 기술 문서의 참고도 88% 였는데 점.. 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가지 정도 성공의 요인을 .. 2024년 7월 테크니컬 라이팅 이런 저런 소식 7월 10일벌써 7월이네요 ㅠㅠTransforming Developer Experience: A New Era for Twilio's Documentationhttps://www.twilio.com/en-us/blog/new-era-for-twilio-documentationtwilio에서 문서화 플랫폼을 전환한 경험을 공유합니다. 5000페이지와 2만여 개 정도의 샘플 코드를 새로운 플랫폼으로 전환했다고 합니다. "새로운"이 중요한 것이 아니라 장기적으로 개발자, 사용자와 소통하고 프로세스에 따라 작업할 수 있는 환경으로 전환했다는 것이 중요한 듯합니다.문서화 시스템에 남아있던 기술적인 부채를 정리하면서 로딩 성능이 좋아졌고 샘플 코드를 테스트하고 관리하는 부분도 개선되었다고 하네요. 찾아보니 201.. 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.. 이전 1 2 3 4 5 6 7 ··· 45 다음
