본문 바로가기
728x90

분류 전체보기

 (2452)
WTD 애틀랜틱 2023 - 가독성 지표 기반 문서화 지난 2년간 적용해 본 가독성 지표 기반 문서화에 대해 설명합니다. 이번 강의를 위해 오픈소스 도구도 만들었다고 하네요. 가독성 지표를 도입한 이유는 독자들의 인지 부하를 줄이기 위함이었다고 합니다. 2년 전에는 테크니컬 라이터나 스타일 가이드 없이 제각각 만들어진 문서가 있는 상태여서 이를 전반적으로 개선하고 문서화 작업을 다시 진행해야 했습니다. 이 과정에서 리뷰어의 참여가 중요한데 리뷰어(개발자)들의 인지 부하를 줄이면 좀 더 효율적으로 작업하 수 있을 것이라 판단했다고 합니다. 기존 CMS 도구를 사용할 수도 있었지만 가독성을 평가하기 위한 데이터 수집에 최적화된 도구가 필요했기 때문에 직접 도구를 만들어 사용하기로 했습니다. GitHub 저장소에 문서를 커밋할 때 가독성 점수를 체크하고 이전 문..
WTD 애틀랜틱 2023 - 문서 구조화에 대한 생각 북미의 아파트 정책이 슬럼화된 것이 하향식 정책이 만들어낸 대표적인 실패라고 언급하고 있습니다. 도시를 설계할 때 거주자의 시선이 아니라 하늘에서 바라보는 새의 시선으로 만드는 것이 문제였다고 합니다(물론 독특하게 한국에서는 성공을 했지만 시간이 지나면 한국도 슬럼화가 될 수 있다는 경고도 있네요). 정보를 디자인하는 것도 마찬가지입니다. 일반적으로 사이트를 구성하는 방식은 트리 구조입니다. 루트가 있고 그 아래에 가지를 뻗어서 정보를 배열합니다. 고전적인 방법이고 누구나에게 익숙한 것이죠. 하지만 실제 독자가 정보에 접근하는 것은 트리를 따라 접근하는 것이 아닙니다. 테크니컬 라이터로 조직에 처음 합류하게 되면 온보딩 코스 대신 문서만 받고 이를 실제 활용해 보는 것을 추천합니다. 실제 독자의 입장에서..
오랜만에 비주얼 스튜디오 코드에서 C++ 프로젝트 개발하기 갑자기 C++ 프로젝트를 다루어야 할 일이 생겨서 예전에 비주얼 스튜디오 코드에서 어떻게 했던 기억이 나서 찾아보니 다행히 기록해놓은 글이 있었네요. 2020.02.11 - [테크니컬 라이팅] - 비주얼 스튜디오 코드에서 C++ 프로젝트 개발하기 그때만 해도 C/C++ 확장 기능이 프리뷰였는데 이제는 1.19.1 정식 버전입니다. 그때와 같은 링크지만 그쪽 콘텐츠도 업데이트되었습니다. 그냥 순서대로 진행하면 끝~ https://code.visualstudio.com/docs/cpp/config-mingw
댓글, 방명록은 로그인 사용자만 허용하도록 변경했습니다 밤 사이에 해킹 시도로 의심되는 댓글, 방명록 기록이 잔뜩 남아있어 일단 급한 대로 댓글, 방명록은 로그인 사용자만 허용하도록 변경했습니다. 뭐 댓글이나 방명록은 1년에 몇 번 남겨지긴 하지만 혹시나 불편을 느끼실 분들을 위해 죄송하다는 말씀을 ^^ 이런 식으로 댓글이나 방명록이 라인 단위로 코드를 입력하면 이걸 어떻게 한 번에 실행할 수 있는 방법이 있는 걸까요? 궁금하긴 하지만 혹시나 잘못된 접근으로 실행이 될까봐 그냥 삭제해버리긴 했습니다. 티스토리 설정에서 해외 IP에 대한 접근 시에는 그림문자를 입력하도록 해놓았는데 아마 그것도 더 이상 소용이 없는 것이 아닌가 싶네요. 티스토리에서도 이런 문제(이것 외에도 구독 유도 등 다른 문제도)를 포함해 12월 중에 스팸으로 의심되는 댓글은 자동으로 삭제..
WTD 애틀랜틱 2023 - 나도 모르게 문서에서 정보가 노출될 수 있습니다 다양한 내용의 문서화가 중요해지고 온라인상에서 접근할 수 있는 문서가 많아지면서 정보 보안에 관련된 이슈가 생길 수 있습니다. 잘 모르는 곳에서 정보가 새는 상황이 생기기도 합니다. 템플릿은 워드를 기반으로 작성하는 경우를 설명합니다. "dotx"라는 문서 포맷은 처음 들어보는데요. 워드 템플릿 파일이라고 합니다. 구글이나 네이버에서 찾아보면 이게 무슨 파일이야 정도 설명하는 글들만 보이고 실질적으로 이를 템플릿으로 어떻게 쓰는지에 대한 설명은 찾기 힘듭니다. 그만큼 잘 쓰지 않는다는 이야기겠죠. 대부분의 경우에는 문서와 형식을 구분해서 사용하고 있기 때문에 워드 기반의 작업을 하는 곳은 점점 줄어들고 있긴 합니다. 그럼에도 워드를 사용해야 한다면 dotx를 검토해 보는 것도 나쁘지 않겠네요. 스크린샷 ..
2023년 12월 테크니컬 라이팅 이런 저런 소식 12월 4일 테크니컬 라이팅에 프롬프트 엔지니어링 활용하기 https://insight.infograb.net/blog/2023/11/29/tw-prompt 테크니컬 라이팅에 프롬프트 엔지니어링 활용하기 이 글에서는 프롬프트 엔지니어링을 테크니컬 라이팅에 활용해야 하는 이유를 살펴보고요. 이 기술을 도입할 만한 테크니컬 라이팅 업무, 효과적인 테크니컬 라이팅용 프롬프트 요건, 테크니컬 insight.infograb.net 제목과는 다르게 프롬프트 엔지니어링이라기보다는 챗 GPT 활용하기가 좀 더 적절하지 않나 싶습니다. 본문 내에 뤼튼을 사용하는 사례가 보이기도 했는데 뤼튼은 12월 20일부터 기존 유료 서비스를 무료로 전환한다는 발표를 했습니다. 뤼튼 서비스의 초기 타켓이 테크니컬 라이팅 분야이기도 했..
WTD 애틀랜틱 2023 - 단일 소스 용어집 구축하기 플랫폼 간에 같은 기능을 설명하기 위해 다른 용어를 사용하는 문제가 있습니다. 이런 문제를 해결하기 위해 다양한 조직 담당자들이 워킹그룹을 만들고 기존에 사용하던 용어, 정의를 모두 정리했습니다. 그리고 모든 토론 과정을 GitHub에 기록으로 남겼습니다. 만들어진 용어집은 다양한 서비스에서 제공되기를 원했습니다. 기술지원포털뿐 아니라 번역 관리 시스템 등에서도 말이죠. 그리고 실제 서비스에서도 용어에 대한 정의를 확인할 수 있어야 했습니다. 이를 구현하기 위해서는 기계가 읽고 처리할 수 있는 단일 소스의 거대한 용어집이 구현되어야 했습니다. Hugo 같은 경우 기능을 확장하기 위해 Modules을 지원하고 있습니다. 그래서 용어집을 Hugo Module로 만들고 이를 각 서비스에서 가져와 사용하도록 구..
WTD 애틀랜틱 2023 - 테크니컬 라이터와 처음 협업해본 UX 전문가의 이야기 Katie Riker는 UX 전문가로 12년 차입니다. 지금은 레드햇에서 일하고 있구요. 10년 차까지는 테크니컬 라이터와 일해본 경험이 없다고 합니다. 그러다가 최근에 새로운 제품을 개발하는 조직에 합류하면서 테크니컬 라이터와 함께 작업을 할 기회가 있었는데 정말 놀라운 경험이었다고 합니다. 그 이유는 UX와 테크니컬 라이팅의 역할(범위)이 비슷하기 때문이라고 생각했답니다. 테크니컬 라이터와의 협업 중 하나는 UI 라이팅 작업입니다. 테크니컬 라이터는 각 제품(서비스) 간 같은 용어를 다른 의미로 사용하는 것을 분석하고 이를 조정하는 작업을 이끌어주었다고 합니다. 아래 그림처럼 표로 만들어서 분석하는 방법이 인상적이네요. 그리고 새로운 용어를 사용하게 되면 이를 정의하고 어떤 과정을 거쳐 만든 용어인지..
반응형

티스토리툴바