본문 바로가기

테크니컬 라이팅/이런 저런 소식

2024년 8월 테크니컬 라이팅 이런 저런 소식

반응형

8월 8일

Stack Overflow 개발자 설문조사 2024

https://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% 였는데 점점 줄어들고 있는 추세이긴 합니다. AI에 대한 참고가 늘어나면서 물리적으로 기술 문서를 직접 참고하는 비중이 줄어든다고 할까요? 물론 중복 답변이기 때문에 검색은 AI를 사용하고 실제 기술 문서를 참고할 수도 있긴 합니다만 저도 문서를 직접 확인하지 않고 AI 답변만으로 참고를 하기도 해서 ㅠㅠ

이전 설문 결과: https://survey.stackoverflow.co/

 

 

AI를 위한 UI 패턴

https://story.pxd.co.kr/1783

 

기술 문서에 AI 검색, 답변 등의 기능을 추가하려고 할 때 참고할만합니다.

...과거에는 상호작용이 필요 없거나(1st), 명령을 통해 세부적인 작업을 지시했지만(2nd), 이제는 사용자가 의도를 전달하면 AI가 결과를 제공하는 방식이 되었다는 것입니다(3rd). 이 새로운 상호작용 방식은 앞으로 UX 디자인할 때 항상 염두에 두어야 할 것이다냥ฅ(^・ω・^ฅ)...

(오늘 8월 8일이 세계 고양이의 날이라 냥체가 적용되었다고 합니다. 이 역시 AI 덕분? 이죠).

 

8월 12일

Could reading instruction manuals become a thing of the past?

https://www.bbc.com/news/articles/cw9yzw4ywnpo

기사 제목은 좀 자극적인데요. 몇 가지 사례를 소개하고 있습니다.

- Aveva의 경우 기술 문서에 있는 정보를 AI를 사용해 엔지니어가 필요한 정보로 만들어주는 일을 합니다. 이미 많은 곳에서 활용하고 있는 방식이죠. 정확하게 어떤 식으로 동작하는지는 모르겠으나 시각적으로 영향을 받는 기계의 이미지도 생성할 수 있다고 합니다.

- Dozuki의 경우는 CreatorPro라는 서비스를 다루고 있는데 엔지니어가 동영상으로 사용법을 촬영해서 업로드하면 이를 단계별로 구분해서 문서로 만들어준다고 합니다. 만들어진 문서를 검증하고 확인하는 절차가 필요하겠지만 어느 정도 틀을 갖춘 초안을 쉽게 만들 수 있는 점에 초점을 맞추고 있는 듯합니다.

https://www.dozuki.com/creatorpro

- Scribe는 PC에서 작업하는 내용에 대해 CreatorPro처럼 단계별 가이드 문서를 만들어줍니다.

아래 도움말이 만들어진 결과에 대한 샘플입니다.

https://support.scribehow.com/hc/en-us/articles/13546388647453-How-to-capture-a-Scribe

결론적으로는 기술문서를 바닥부터 만드는 일은 점점 줄어들 것이다 뭐 그런 이야기 같고요.

특정 서비스를 쓰는 경우에는 아무래도 서비스에 종속되는 문제가 있다는 것은 고려해야 할 것 같네요.

 

8월 19일

Personal technical writing style guide

https://minaelee.com/technical-writing-guide/

새로 업데이트된 글은 아니지만 누군가 발견해서 공유한 내용입니다. 기술 문서 스타일 가이드를 만든다고 하면 뭔가 거창한 일이라고 생각하는데 일반적인 원칙은 범용적인 스타일 가이드(구글이나 마이크로소프트 같은 곳에서 만든)를 참고하고 내가 개인적으로 기술 문서를 작성하면서 자주 실수하거나 추가하고 싶은 내용을 정리하는 방식 같네요.

테크니컬 라이터 뿐 아니라 블로그를 쓰거나 기술 문서를 작성하는 엔지니어라면 권장할 만한 방법입니다.

 

8월 20일

차니 블로그 20주년 – 글쓰기에서 인생을 찾다

https://channy.creation.net/blog/1870

...돌이켜 보면, 꾸준히 뭔가 기록에 남기다 보니, 거기서 새로운 맥락을 찾고, 덕분에 삶에 있어 새 동기를 부여할 수 있게 되었습니다. 제 커리어를 통틀어 글 쓰기를 통해 새로운 변화를 인지하고 뭔가 만들어 내는 계기가 되었던 것 같습니다...

 

8월 22일

https://docs.cursor.com/context/@-symbols/@-docs#docs

새로운 소식은 아니고 다른 영상을 보다가 발견한(?) 기능입니다. 요즘 개발자들이 많이 사용하는 cursor라는 AI 서비스에서는 해당 프로그래밍 언어의 공식 문서 또는 커스텀 문서를 등록하고 그 문서를 기반으로 코드 작성을 도와주는 기능을 사용할 수 있다고 하네요.

 

8월 29일

ChatGPT를 활용한 B2B 테크니컬 라이팅 (3차)

TTA에서 진행하는 교육입니다. 올해 마지막 교육이구요. 9월 12일 하루 진행되는 교육입니다.

https://champ.tta.or.kr/usr/EgovUsrEduRecruitingDetail.do?idx=416&baseUsrMenuNo=3&imgNum=1&pageIndex=1

728x90