본문 바로가기
728x90

테크니컬 라이팅

 (353)
당구장 표시에 대해 위키백과에서는 "참고표"라고 이름을 붙였습니다. 해당 기호의 유니코드 이름이 "Reference Mark"인데 이를 번역한 것으로 보입니다. 한국과 일본에서만 사용한다고 합니다. 한국에서 이를 "당구장 표시"라고 부르는 것처럼 일본에서는 "こめじるし、米印"라고 부릅니다. 위키백과에서는 "참고표(參考標, reference mark)는 다음 내용을 참고하라는 의미로 사용하는 문장 부호이다."로 설명하며 문장 부호라고 하는데 국립국어원에서 규정한 문장 부호에는 해당 기호가 포함되지 않았습니다. 관련 질문에 대한 답변에서도 문장 부호가 아니기 때문에 답을 할 수 없다고 합니다. https://www.korean.go.kr/front/onlineQna/onlineQnaView.do?mn_id=216&qna_seq..
WTD 호주 2022 - 처음 인터뷰어로 참여하는 이들을 위한 팁 Ishara Ilangasinghe는 개발자로 경력을 시작했고 테크니컬 라이팅 업무에 관심을 가지고 현재는 테크니컬 라이터로서 일하고 있다고 합니다. WSO2라는 오픈소스 API 관리 플랫폼을 개발하는 기업에서 테크니컬 라이터로 일하고 있습니다. 테크니컬 라이터 지원자를 인터뷰하는 인터뷰어로서 첫 경험을 공유합니다. 첫 인터뷰를 준비하면서 인터뷰어의 관점에서 자료를 찾아보았지만 정보가 거의 없었다고 합니다. 인터뷰이 관점에서 인터뷰를 준비하기 위한 리소스는 많지만 그 반대는 찾기 힘들다는 것입니다. * 테크니컬 라이터 지원자를 위한 인터뷰라는 제목이지만 딱히 테크니컬 라이터 지원자가 아니더라도 적용할만한 내용입니다. 그렇게 보면 리소스가 그리 적지는 않을 텐데 말이죠. 인터뷰 준비 1. 이력서 검토하기 ..
ISO/IEC 15910-2002는 무슨 문서일까요? 아래 내용에서 '표준'의 출처는 'ISO/IEC 15910-2002'라고 합니다. 하지만 ISO 표준 문서에는 15910-2002라는 문서는 없습니다. 15910-1999가 마지막이고 그 이후에는 26512가 이를 대체합니다. ISO/IEC 표준에 따르면 문서 한 페이지의 초안을 작성하는 데 1시간이 소요된다고 합니다. ISO 표준에 따르면, 페이지당 내용 리뷰에는 30분, 단순 교정 작업에는 약 15분이 소요됩니다. 2023년 기준 26512:2018 문서가 최종이네요. https://www.iso.org/standard/72088.html ISO/IEC/IEEE 26512:2018 Systems and software engineering — Requirements for acquirers and s..
WTD 호주 2022 - 표준에 따라 기술 문서 작성하기 Shumin Chen은 싱가포르의 shufrans-techdocs라는 기술문서 전문 기업에서 STE(Simplified Technical English) 업무를 담당하고 있습니다. STE는 ASD-STE100라는 스펙으로 정의되어 있습니다. 2019년 출간된 "테크니컬 라이터가 되려는 당신에게"에서 간략하게 ASD-STE100를 소개하는 내용이 포함되어 있었습니다. WTD에서는 주로 소프트웨어 산업의 기술 문서를 중심으로 다루다 보니 국제 표준에 대한 언급은 많이 없었는데 이번 세션에서는 최근 국제 표준 관련 트렌드에 대해 다루고 있습니다. 문서화의 중요성에 대해서는 많은 산업에서 강조되고 있지만 표준에 대해서는 무시되는 경향이 있습니다. ASD-STE100 같은 표준을 따르는 것은 테크니컬 라이터, 독..
'갈피를 잡지 못하다'라고 할 때 '갈피'가 '송아지(calf)'라고? '갈피'라는 단어는 2가지 의미를 가지고 있습니다. 1. 겹치거나 포갠 물건의 하나하나의 사이. 또는 그 틈. 십칠팔 년 전의 일이 노트 갈피 속에 숨어 있다가 되살아왔다. 2. 일이나 사물의 갈래가 구별되는 어름. 갈피를 못 잡다. 첫 번째는 '책갈피' 또는 '꽃-갈피'라는 단어에서 많이 들어보았을겁니다. 사전 설명과 같은 '노트 갈피'는 뭔가 낯설어보이네요. 두 번째도 많이 사용하는 표현입니다. 뭔가 일의 방향을 정하지 못하고 혼란스러울때 '갈피를 잡지 못했다' 뭐 이런 식으로 사용합니다. 이게 한자어 같은데 사전에는 한자어가 아니라고 설명하고 있습니다. 구글에서 '갈피'의 어원을 찾아보면 아리아 인의 언어에서 갈라진 말이라고 합니다. 영어 송아지를 의미하는 'calf'라는 단어가 우리말로 정착된 것..
WTD 호주 2022 - 문서가 해커 공격의 매개체가 될 수 있다 Lilly Ryan은 독특한 커리어를 가지고 있습니다. 역사 전공으로 중세 유럽의 감시 시스템을 연구하다가 소프트웨어 엔지니어가 되었습니다. 현재는 Thoughtworks에서 보안 전문가로 일하고 있습니다. 자신이 진행하는 인터뷰 채널에 Heidi Waterhouse(Docs for Developers의 저자 중 한명)가 참여해 보안 전문가들과 테크니컬 라이터가 일하는 방식에 대해 이야기했는데 그때 얻은 아이디어를 바탕으로 강연을 진행한다고 합니다. 예를 들어 보안 전문가가 침투 시험(Penetration test)를 진행할 때 취약점을 찾기 위해 문서를 샅샅이 읽습니다. 문서를 읽는 방식은 두 가지입니다. 첫 번째는 일반 사용자들과 마찬가지로 소프트웨어의 사용법(어떤 작업을 수행하는 방법)을 알기 위해..
WTD 호주 2022 - 커뮤니티 주도 문서화 프로젝트 이끌기 Sarah Rainsberger는 오픈소스 프로젝트 astro의 문서 작성 책임자입니다. astro에 합류하기 전에는 교육계에서 일했다고 합니다. 과외 같은 수업도 진행했는데 커뮤니티 주도로 문서를 작성하는 astro에서는 그런 역할이 필요했나 봅니다. 가이드를 제공하고 작성한 글을 첨삭해 주는 역할입니다. https://docs.astro.build/en/getting-started/ 문서가 기술적으로 정확한 것만으로는 충분하지 않습니다. 문서는 커뮤니티의 요구를 충족시켜야 합니다. astro는 커뮤니티 주도로 문서를 작성합니다. 여기에는 3가지 원칙이 있습니다. 협업, 적용, 참여입니다. - 협업 깃헙을 통해 문서 소스 코드를 공개하고 문서화 프로세스를 확인할 수 있습니다. 그리고 어느 정도 문서화가..
TCN 2023년 2월 밋업 정리 2월 16일 저녁 8시부터 진행된 행사입니다. 온라인으로 진행됐고 Q&A는 채팅을 통해 진행했다고 합니다. 오전까지는 밋업이 있다는 것을 생각하고 있었는데 저녁 식사 이후에 머릿속에서 일정이 사라져 버렸네요. 그래서 다음 날 유튜브 영상으로 봤습니다. 때문에 Q&A에서 어떤 이야기가 오고 갔는지 알 수 없습니다. 데브시스터즈 남정현 아마 이미 읽어보신 분들도 많을텐데 '개발자에서 기술 작가로 전직하기까지 2년 간의 이야기'의 주인공입니다. 단순한 전직이 아니라 팀을 만들어가는 과정이 담겨 있어서 테크니컬 라이팅 조직이 없거나 혼자서 일하고 있다면 참고할만한 내용입니다. 물론 커뮤니티에서 꽤 오랫동안 활동을 해왔었고 사내에서도 어느 정도 영향력을 가지고 있던 분이라 가능했던 일일 수도 있습니다만 ^^ ht..
반응형

티스토리툴바