본문 바로가기
728x90

테크니컬 라이팅

 (310)
향상된 맞춤법 검사와 그냥 기본 맞춤법 검사의 차이 이전 글을 쓰면서 '향상된 맞춤법 검사'는 뭐가 다른 건지 설명하고 싶었는데 그 차이를 발견하지 못했습니다. 2022.10.13 - [그냥 블로그] - 향상된 맞춤법 검사 사용 시 주의 사항 우연히 글을 쓰다가 향상된 맞춤법 검사기의 독특한 기능을 발견했습니다. 바로 고유명사에 대한 처리입니다. 예를 들어 아래 그림은 '기본 맞춤법 검사' 옵션을 선택한 상태인데 '프레임워크를' 이라는 표현만 맞춤법 체크를 위한 하이라이트 표시를 해줍니다. 이제 '향상된 맞춤법 검사' 옵션을 활성화한 후에 다시 들어가보면 좀 다른 부분을 다른 색상으로 표시합니다. 색상이 회색이라 잘 보이지 않지만 'Jekll'이라는 항목에 하이라이트 표시가 되었습니다. 원래 의도는 'Jekyll'인데 오타로 'Jekll'이 입력됐습니다...
향상된 맞춤법 검사 사용 시 주의 사항 크롬 브라우저에서는 언어별 맞춤법 검사 기능을 지원합니다. 언어별로 활성화 여부를 사용자가 선택할 수 있습니다. 기본 설정은 "기본 맞춤법 검사"입니다. 이건 크롬 또는 운영체제에서 제공하는 맞춤법 검사를 사용합니다. 도움말을 보면 윈도우 8 이상 운영체제에서는 윈도우에서 제공하는 맞춤법 검사를 사용한다고 합니다. 윈도우에 설치된 언어팩을 보면 기본 맞춤법 검사 기능과 이에 필요한 사전이 설치되어 있다고 표기되어 있습니다. 윈도우 옵션 중에 Typing 옵션에서 맞춤법을 검사하고 이를 표시하게 하는 옵션이 있습니다. 해당 옵션을 활성화하면 Settings 같은 곳에서는 맞춤법을 검사해주는데 메모장에서는 검사해주지 않습니다. 아마도 뭔가 애플리케이션 내에서 기능을 연결해주어야 하나 봅니다. 마이크로소프트에..
라인 밋업 정리(2/2) - 테크니컬 라이터에 관한 오해와 진실 지난 9월 29일 '우리는 LINE의 테크니컬 라이터입니다'라는 제목으로 2개의 세션을 진행했습니다. 그중 두 번째 세션이 공개됐네요(세 번째 세션은 Q&A일 듯합니다). 발표자는 역시 라인 테크니컬 라이터 전정은 님입니다. 2020년 7월 "라인의 전정은 님이 말하는 테크니컬 라이팅의 모든 것"이라는 제목으로 공개된 영상도 있습니다. 같이 보시면 좋겠네요. https://youtu.be/kEwdl2B1SQc 발표 순서는 아래와 같습니다. 1. 소개(나는 누구) 2. 왜 나섰는가? 3. 내가 하는 일은? 4번부터 7번까지는 사전 설문을 통해 수집한 자료라고 합니다. 4. 한국 테크니컬 라이터 분포 5. 문서만 다루는 사람인가요? 6. 개발할 줄 알아야 하나요? 7. IT계열 테크니컬 라이터의 도구 블라인..
라인 밋업 정리(1/2) - 테크니컬 라이터가 하는 일 지난 9월 29일 '우리는 LINE의 테크니컬 라이터입니다'라는 제목으로 2개의 세션을 진행했습니다. 그중 첫 번째 세션이 공개됐네요. 영상 내 자막이 포함된 걸로 보아서 라이브 영상을 일부 편집해서 올린 것이 아닌가 싶습니다(개인적으로는 자막이 있는 걸 좋아하긴 하지만 그걸 또 싫어하는 분들도 있더라구요. 그래서 별도 자막으로 올려서 유튜브에서 자막을 끌 수 있는 옵션을 주었다면 어떠했을까 하는 점이 아쉽네요). 발표자는 라인 테크니컬 라이터 이인실 님입니다. 2019년 5월 진행했던 WTD Seoul 밋업 행사 때 발표를 하기도 했습니다. 일부 발표 내용은 겹치기도 해서 어디선가 들었던 내용인데 싶어 찾아보았습니다. https://festa.io/events/301 발표 내용은 4가지입니다. 1. 테..
WTD 프라하 2022 - 인앱 메시지에 대한 소개 Prashant는 acceldata.io라는 o11y(Observability) 솔루션 기업에서 테크니컬 라이터로 일하고 있습니다. acceldata는 산호세에 본사가 있고 벵갈루루에 오피스를 가지고 있습니다. Prashant는 벵갈루루 오피스에서 일하고 있습니다. Adoption(채택, 선정) 제품 마케팅 방식 중 체험판을 활용하는 방식이 있는데 이런 경우 일정 기간 체험판을 사용하다가 실제 제품 고객으로 전환하는 것이 중요합니다. 사용자 입장에서는 해당 제품을 Adoption 하는 것이죠. IN-APP Messaging(인앱 메시지) * 구글에서는 상황별 메시지로 번역하기도 합니다. 앱 내에 표시되는 모든(대부분) 메시지 일반적인 환경에서는 제품과 문서가 별개로 존재하고 서로 상호 영향을 미치는 구조..
WTD 프라하 2022 - 질문의 기술 Jeff는 strongdm이라는 액세스 관리 솔루션 업체의 테크니컬 라이팅 팀을 담당하고 있습니다. 웹 개발로 시작해서 2016년부터 테크니컬 라이팅 업무를 시작했습니다. 웹 개발은 독학으로 시작했고 직장에 다니면서 프리랜서로 웹 개발, 기술 글쓰기 등을 해왔다고 합니다. 3가지 키워드를 가지고 질문하기에 대해 설명합니다. 발표자가 뭔가 쉬지 않고 계속 말하는 스타일이라 많은 이야기를 해서 잘 정리가 되질 않네요. Confidence(자신감) - 질문하는 것을 미안해하지 마세요. - Technical writers often report high percentages of imposter syndrome in the workplace. 이건 좀 이해하기 어렵긴 한데 가면 증후군보다는 자신감의 문제라고 생..
WTD 프라하 2022 - 독자와 관계 구축을 통해 문서 개선하기 문서 이해관계자(독자)와의 관계 구축을 통한 콘텐츠 개선하기가 주제입니다. Taylor는 Splunk에서 테크니컬 라이터로 일하고 있습니다. 4년 전 어떤 문서를 개선한 경험에 대해 이야기를 시작합니다. 기존 문서는 뭔가 불편함이 있었다고 합니다(정확하게 어떤 문제였는지는 언급하지 않고 있습니다). 그래서 이런 피드백을 수용하고 개선하기로 결정하고 PM과 어느 정도 범위에서 진행을 할지 협의했다고 합니다. 아래와 같은 점을 수정했습니다. - 태스크 기반 가이드 문서 작성 - 문서, SDK, 예제 저장소에서 사용하는 용어 표준화 - 개발자가 활용할 수 있는 도구, 리소스 소개 - 업데이트되지 않고 정확하지 않은 콘텐츠 제거 프로젝트의 결과로 - 정확하고 최신 코드에 맞는 가이드 문서를 작성했고 - 여러 곳..
WTD 프라하 2022 - Aiven에서는 Lint를 어떻게 사용하나요 Tony Ibbs는 Aiven에서 개발자 교육을 담당하고 있습니다. Aiven는 오픈 소스 클라우드 데이터 플랫폼이라고 하네요. 국내에는 잘 알려지지 않은(검색해 보았을 때) 핀란드 회사입니다. 작년 프라하 컨퍼런스에서는 세션은 담당하지 않고 라이트닝 토크에서 아포스트로피 사용에 대한 짧은 이야기를 전했었네요. 슬라이드를 공개해놓았습니다. 뭐 길지 않은 슬라이드이긴 하지만 ^^ https://github.com/tibs/beyond-spellchecking-talk 문서를 검토하는 가장 좋은 방법은 동료 검토자가 있어서 검토를 요청할 수 있는 것입니다. 하지만 그렇지 않은 경우가 많죠. 조직 내에서 혼자만 문서 업무를 담당하고 있을 수 있고 검토 요청을 하기에는 다들 서로 바쁜 경우엔 그렇죠. 그래서 그..
반응형

티스토리툴바