테크니컬 라이팅 (353) 썸네일형 리스트형 2022년 8월 테크니컬 라이팅 이런 저런 소식 8월 5일 codenary라는 사이트를 이제야 알았네요. 각 기업에서 어떤 기술 스택을 사용하는지 알아볼 수 있는 사이트입니다. SK플래닛에서 공유한 글을 보면 기업에서 자료를 제출하면 기술 스택 정보를 제공하는 형식인 듯합니다. https://www.facebook.com/README.SKP/posts/pfbid0xnLkzxkC89nQeWchtmdsWd4WQ5ExNwzvN8b4QaeTvKGNgGKgzkiRZFWR5jQD1Qd7l 문서화 도구 관련해서도 찾아보았는데요. 아무래도 nextjs 같은 도구는 꼭 문서화에만 사용하는 것이 아니라서 꽤 많은 기업에서 사용하고 있습니다. docusaurus 같은 경우에는 1곳에서만 사용한다고 등록을 했구요. https://www.codenary.co.kr/techs.. 7월 우아한테크세미나 - 개발자도 글을 잘 써야 한다고요?! 리뷰 확실하게 데브렐 팀이 진행하는 테크세미나는 뭔가 활력이 넘치네요. 최근에 슬랙에서 진행한 세미나도 그렇고 이번 세미나도 그렇구요. 세미나 내용을 정리한 건 아니고 중간중간 개인적인 메모로 남긴 내용입니다. 전체 내용은 공개된 영상을 참고하세요. 글쓰기에 진심인 우아한 형제들 우아한 형제 기술 블로그의 월 평균 조회수 15만 회 이상이라고 합니다. (생각보다 조회수가 많지는 않네요. 일 평균으로 보면 5천 회 정도라서 좀 괜찮은 개인 기술 블로그랑 비슷한 수준인 듯합니다.) 그룹별 글쓰기 모임도 가지고 있음(데브렐팀과 테크니컬 라이터 코치가 같이 참여) 개발자는 지식노동자! 지식의 공유가 곧 기술 커뮤니티를 향한 공헌이자 개인역량과 영향력의 강화입니다. 글쓰기를 통해 지식의 공유를 더 활발히 하고 우아한형.. 2022년 7월 테크니컬 라이팅 이런 저런 소식 7월 4일 AWS 일부 문서에는 "기여자(Contributors)" 항목이 있습니다. 테크니컬 라이터뿐 아니라 문서 작성에 관여한 컨설턴트, 엔지니어의 이름이 기록됩니다(주로 백서 성격의 문서인 경우에 항목이 있습니다). 내부적으로는 버전 관리를 하면서 누구누구가 해당 문서를 작성하고 검토했는지 알 수는 있겠지만 이처럼 외부에 문서 작성에 기여한 이들의 이름을 표기하는 방식도 신선하네요. https://docs.aws.amazon.com/ko_kr/prescriptive-guidance/latest/security-reference-architecture/contributors.html 7월 5일 아마존 웹 서비스의 테크 에반젤리스트 윤석찬 님의 글입니다. 아마존에서의 글쓰기 문화에 대한 이야기는 많이 .. Technical Writer HQ - 스플렁크(Splunk) 테크니컬 라이터 인터뷰 (6) Brittany Burrell은 Splunk의 테크니컬 라이터입니다. 지원팀의 지원 정책, 프로세스 전반에 대해 문서화하는 업무를 담당하고 있습니다. 대학에서 테크니컬 커뮤니케이션을 전공했고 졸업 이후 바로 관련 기업에 취업을 했습니다. 몇 개 작은 기업과 IBM을 거쳐 Splunk에서 2019년부터 일하고 있습니다. 영상 시작 부분에서 "The Product is Docs"라는 책을 언급하는데 Brittany Burrell은 이 책에 직접적으로 참여하지는 않은 듯합니다. 해당 책 후기 마지막에 참여한 스태프들의 이름을 언급하는데 그녀의 이름은 보이질 않네요. 테크니컬 라이터에게 중요한 것은 자신이 모든 것을 알 수 없다는 사실을 이해해야 합니다. 물론 자신이 작업할 영역에 대한 기본적인 이해는 필요하며.. REST Docs는 뭔가요? 토스의 SLASH 22 영상을 보다가 배포 관련 설명에서 "...Rest Docs 테스트를 거쳐 사내 API 카탈로그에 게시하고..."라는 말이 귀에 들어왔습니다. 뭔가 문서화 이야기를 하는 것 같은데 처음 들어보는 표현이라 찾아보았습니다. 구글 검색에서 REST Docs 사이트가 가장 먼저 노출되고 그 다음에 나오는 것은 국내 개발자들이 작성한 글이었습니다. 배민 정산시스템 API 문서를 위키에서 Rest Docs로 전환했다는 글이 가장 처음에 나오고(아마 워낙 인기 있는 글이라 그런가 봅니다) 그 외에도 꽤 많은 글이 나옵니다. 한국어가 아닌 글을 찾으려면 한참 밑으로 내려가야 합니다. 그렇다면 이미 많은 곳에서 API 문서를 작성할 때 REST Docs를 사용한다는 거 같네요. 하지만 WTD 슬랙에.. 갑자기 '연동'이라는 단어가 어색하게 느껴져서 페이먼트 관련 문서를 보다가 갑자가 '연동'이라는 단어가 뭔가 어색하게 느껴졌습니다. 찾아보니 꽤 많이 사용하는 표현인데 그 정확한 의미를 알지 못하는 것이 아닌가 싶었던 거죠. 물론 이 글에서도 딱히 정답은 없습니다. 사전적 의미 연동 連動/聯動 한자 표기는 2가지 형태로 사용하는데 의미는 같습니다. 표준국어대사전에서는 '기계' 관련 의미만 등록되어 있는데 고려대한국어대사전에서는 '경제' 관련 의미가 같이 올라와있습니다. 실제 뉴스를 검색해보면 환율, 주가 등을 설명하면서 많이 사용되는 표현입니다. - 표준국어대사전 기계나 장치 따위에서, 한 부분을 움직이면 연결되어 있는 다른 부분도 잇따라 함께 움직이는 일. - 고려대한국어대사전 물가 정책 따위에서, 어떤 것의 값이 오르내림에 따라 그와 관련되는 것.. UI 텍스트 번역의 어려움 일반 문서 번역은 앞뒤 맥락이 있으니 어느 정도 감을 잡고 번역할 수 있습니다. 하지만 UI 텍스트의 경우에는 좀 다릅니다. 해당 문장 또는 단어가 어떤 의미로 쓰인 것인지 파악하는 것이 쉽지 않습니다. 해당 화면 이미지를 직접 보면서 번역한다면 쉽겠지만 그렇지 않다면 전혀 다른 의미나 의도로 번역하게 될 수 있습니다. (저는 전문 번역 작업을 하지 않습니다. 그냥... 구글 번역기의 힘을 빌어 흉내만 내는 정도입니다). 예를 들어 다음과 같은 단어의 경우가 그렇습니다. 번역할 대상은 'to select'이고 그 아래에 간단한 설명이 포함되어 있습니다(이런 설명도 과분한 상황이죠). "The explanatory text of the action for the enter key"라는 설명으로 보면 사용자.. Netflix 에러 U7353-5101 점심시간에 넷플릭스를 잠시 접속하는데 해당 시간대 사용자가 몰려서 그런지 간혹 버퍼링이 심할 때가 있습니다. 그래서 윈도우용 넷플릭스 앱을 설치하고 볼 영상을 내려받고 봅니다. 근데 가끔 U7353-5101 이라는 에러 코드가 뜨면서 저장한 영상 재생이 되지 않습니다. 구글에서 해당 코드를 찾아보면 안내 페이지가 나오긴 합니다. https://help.netflix.com/ko/node/100647 그리고 문제 해결 팁으로 앱 재설정을 권장합니다. 근데 흥미롭게도 해당 에러는 저장한 영상(또는 영상 정보)에 문제가 있는 것이고 그냥 해당 영상을 삭제하고 다시 내려받으면 해결됩니다. 굳이 복잡하게 앱 재설정을 할 필요가 없는 것이죠. (물론 문제가 반복된다면 재설정이 뭔가 해결해줄 수도 있을 듯한데 이건 .. 이전 1 ··· 16 17 18 19 20 21 22 ··· 45 다음
