본문 바로가기

테크니컬 라이팅/WTD 컨퍼런스

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가지 정도 성공의 요인을 들 수 있는데 그중 하나가 전체 구조를 볼 수 있게 만들었다고 합니다. 엑셀 시트로 모든 콘텐츠를 정리했습니다. 누가 담당하고 있고 지금 상태가 어떤지 누구나 볼 수 있게 정리했다고 합니다. 뭔가 도구를 쓴 건 아니고 손으로 한 땀 한 땀 작업한 것입니다.

그리고 콘텐츠를 새로 만들거나 개선하는 작업은 혼자서 할 수 없고 개발팀이 함께 해야 하는데 개발팀의 일정이나 사정을 먼저 고려하는 유화정책을 선택했습니다. 그래서 마감일의 경우 개발자의 일정에 따라 지키지 못할 상황이라면 마감일을 조정해주는 등의 작업을 함께 했다고 합니다.

실제 어떤 식으로 작업했는지는 따로 테이블 세션(?)에서 설명을 하겠다고 하네요(이런 건 온라인으로 채울 수 없는 것이죠~)

* Jewel Darger-Sacher - From Dry Doc to Desert (annual acculturation for challenging conditions)

1년 단위의 행사를 어떤 식으로 기획하는지에 대해 공유합니다. 구체적인 내용보다는 일상적인 업무에만 빠져있지 말고 이런 이벤트를 통해 리프레시할 수 있는 기회를 가져보면 어떨까 하는 제안 같기도 하구요.

* Matthew Brandabur Writers - What's Your Ritual?

시작하면서 청중에게 여러분은 나만의 글쓰기 의식(Ritual)이 있냐고 물어봅니다. 대답 소리가 작아서 영상에서는 잘 들리지는 않지만 청중 반응은 좋네요 ㅠㅠ 그리고 나서 자신의 이야기를 하는데, 딱히 의식보다는 일반적인 테크니컬 라이팅의 원칙 같은 이야기를 합니다. 독자가 누구인지 파악하고 뭐 그런것들이요.

그런데 좀 관점을 바꾸어서 이런 테크니컬 라이터로서의 의식이 삶에도 영향을 미쳤다고 합니다. 자신이 원하는 것에 대해 좀 더 고민하게 되었고 .... 라고 합니다.

* Jessamy Taylor - No one is a wizard: How to learn intimidating things

두려운 일을 배우는 방법이라고 합니다. 예를 들어 이런 것들이죠.

- 새로운 문서 도구 배우기

- 잘 모르는 분야에 대해 문서화하기

- docs as code 적용하기

- 이해하기 어려운 무언가 디버깅하기

- 불편한 공간에서 프로젝트하기

무작정 뛰어들기 보다는 먼저 프레임워크를 찾아라고 합니다. 배우고자 하는 것의 기본적인 개요를 한 발 물러나서 볼 수 있는 것이죠. 요즘은 검색이 좋아져서 구글에서 쉽게 찾을 수 있다는 장점도 있습니다. 초보자를 위한 가이드나 101 코스 같은 것들을 찾으면 됩니다. 너무 많은 시간을 투자하지 않고 15분 정도 짧은 시간을 들여 기본적인 내용을 살펴보는 것입니다.

이 준비 과정은 우리가 원하는 것을 찾기 위해 올바른 질문을 하기 위한 준비 단계입니다. 아무런 지식이 없다면 질문을 할 수 없기 때문에 기본적인 프레임워크에 먼저 집중하는 것입니다.

* Manny Silva  - RAGs to Riches: How Our Content Affects Retrieval Augmented Generation

LLM에서 RAG를 사용하는 방식을 이야기합니다. skyflow라는 서비스는 LLM에서 민감한 데이터를 처리해 주는 그런 서비스 같은데요. 하여간 RAG를 잘 활용하는 방법을 설명합니다. 일단은 LLM에게 RAG가 어떤 내용인지 정보를 잘 정리해서 전달해주어야 합니다. 그래야 정보를 어떻게 가공해서 저장할지 판단하고 잘 활용할 수 있다고 합니다.

좀 더 자세한 내용은 아래 링크를 참고하라고 하네요.
https://stackoverflow.blog/2023/10/18/retrieval-augmented-generation-keeping-llms-relevant-and-current/

 

https://youtu.be/aAZcuK8W714?si=hMxfoDUhF1D9ovwB

 

728x90