본문 바로가기

728x90

전체 글

(2447)
WTD 포틀랜드 2023 - 자동화가 다 좋은 건 아닙니다 Dan은 엔지니어링 배경을 가지고 있으며 여러 분야에서 일을 하다가 지금은 소프트웨어 쪽에서 일하고 있고 문서 작성 특히 API 문서화 관련된 일을 하고 있습니다. API 문서화와 관련해서 다음과 같은 목표를 가지고 있습니다. - 일관성: 누가 어디서 작성을 하든 조직 내 API 문서는 같은 형식으로 작성되고 배포되기를 원합니다. 특히 마이크로 서비스 아키텍처인 경우 각 서비스를 개발하는 조직이 달라지면서 일관성을 잃어버릴 수 있습니다. - 명확성: 최신의 코드 정보를 API 문서가 담고 있어야 합니다. 틀린 내용이 없고 정확한 내용을 포함해야 합니다. 업데이트되지 않거나 오래된 문서에 대한 이야기는 다른 곳에서도 많이 들을 수 있는 이야기입니다. 개발팀과의 관계에 있어서 개발팀의 배포 기준에 문서화를 ..
WTD 포틀랜드 2023 - 연구자의 글쓰기 대부분의 연구소에서는 문서를 작성하기 위한 전담자가 없고 연구 담당자가 문서를 작성해야 하는데 자신의 업무 중 10% 미만의 시간을 들인다고 합니다. 제목에서 SOP는 표준작업지침서(Standard Operating Procedure)의 약자라고 하네요. 구글 검색에서 SOP라고 찾아보면 무슨 규약 같은 느낌으로 작성되어 있던데 발표자가 이야기하는 것과 같은 것인지는 모르겠습니다. 아마도 실험을 진행하기 전에(새로 합류한 연구원인 경우) 꼭 읽어야 하는 문서라고 하니 맞을 것 같습니다. 하지만 실제 조사를 해보면 SOP를 읽는 비중은 46:53이라고 합니다. 53%는 읽지 않는다는 것이죠(뒤에서 언급하긴 하지만 읽는 것을 확인하는 절차는 있습니다). SOP는 새로운 장비의 영향을 받습니다. 새로운 장비가..
2023년 7월 테크니컬 라이팅 이런 저런 소식 7월 4일 채널 박재호 유튜브에 "Docs for Developers 기술 문서 작성 완벽 가이드" 소개 영상이 올라왔습니다. 아직 책을 읽어보지 못한 분들은 영상을 먼저 보시고 어떤 내용을 다루는지 살펴보는 것도 좋을 것 같네요. 번역서에는 11명의 테크니컬 라이터 인터뷰가 실려있는데 꽤 깊은 내용까지 다루고 있습니다. 그 내용만 따로 정리해도 좋을 것 같더군요. https://jhrogue.blogspot.com/2023/07/docs-for-developers.html 7월 5일 MDN에 AI Help 기능이 추가됐습니다. 공식 블로그에 올라온 건 6월 27일이네요. MDN 플러스 회원들에게 제공되며 무료 회원인 경우에는 5번, 유료 회원은 무제한 질문이 가능하다고 합니다. https://devel..
WTD 포틀랜드 2023 - 문서의 '릴리스 레디'는 어떤 상태인가요? 문서화에서 '릴리스 레디'라는 표현은 제품 릴리스 후 24시간 내에 모든 문서와 번역이 완벽하게 완료될 수 있다는 것을 의미합니다. 어찌보면 당연한 거 아닌가 싶기도 한데 제품과 문서가 같은 프로세스를 따라 배포되지 않는다면 문제가 되는 부분이라는 것을 알 수 있습니다. 문서를 코드처럼 다루기랑 비슷한 주제죠. 그래서 이번 발표에서는 안정된 프로세스가 없더라도 '릴리스 레디' 문서 프로세스를 만들 수 있는 팁을 제시합니다. (1) 뭐가 바뀌는지 알기 - 제품팀과 긴밀한 관계를 가지고 계속 커뮤니케이션하는 것이 중요합니다. 궁금한 것은 바로 물어볼 수 있어야 하고 어느 정도의 가시성(신규 개발 일정)을 확보해야 합니다. (2) 규모 확인하기 - 릴리스마다 항상 같은 비중으로 문서가 작성되는 것은 아닙니다...
WTD 포틀랜드 2023 - 테크니컬 라이터로 경력을 이제 막 시작하려는 이들을 위한 여러 조언들 개인 블로그를 통해 10명의 테크니컬 라이팅 관련 업무를 하는 현업을 대상으로 인터뷰를 진행했습니다. 인터뷰 대상을 테크니컬 콘텐츠 크리에이터라고 표현하고 있습니다. https://www.everythingtechnicalwriting.com/tag/interviews/ 인터뷰의 목적 중 하나는 성공한 이들이 어떤 과정을 거쳐서 지금의 자리에 올라왔는지 소개하고 시작하는 이들이 이런 실수를 피할 수 있게 하려는 것입니다. 그리고 어떻게 시작해야 할지 감을 잡을 수 있게 하려는 것이지요. 테크니컬 라이터를 시작하려는 이들이 얻을 수 있는 정보는 어느 곳이나 그렇지만 매우 적습니다. 일부 국가에서는 테크니컬 라이팅 전공이 있는 경우도 있지만 대부분 그렇지 않고 학원 시장에서도 엔지니어 중심의 교육이 이루어지..
WTD 포틀랜드 2023 - 문서를 코드처럼 관리하는 건 항상 쉬운 건 아닙니다 이번 강연은 대충 어떤 이야기인지는 알겠는데 정리가 안되더라구요 ㅠㅠ 그래서 "YouTube & Article Summary powered by ChatGPT"라는 플러그인을 사용해 내용을 요약해 보았습니다. 무서운 세상이네요. 콘텐츠 관리 시스템(CMS)에서 문서를 코드처럼 관리하기로 전환하는 것이 쉽지 않다는 것을 공감합니다. 성공적으로 문서를 코드처럼 관리할 수 있게 하려면 그들을 응원하고 적절한 지침을 제공하는 것이 필요합니다. 문서를 코드처럼 관리하는 장점은 협업, 미리 보기, 통합 워크플로우 등을 이야기할 수 있습니다(물론 요즘 CMS 또는 매뉴얼 저작 도구에서도 이런 것들은 지원하고 있긴 합니다). 조직 내에서 문서를 코드처럼 관리하기로 전환하기 위해 적합성을 평가하고 어느 정도의 비용이 들..
2022 데브옵스 현황 보고서 데이터 심층 분석: 문서화는 봄날의 햇살입니다 2022 State of DevOps Report data deep dive: Documentation is like sunshine 문서에 대한 번역입니다. 한국어 블로그에 번역이 올라오긴 하지만 약 한 달 정도 차이가 있는 것 같더군요. 개인적인 학습 용도이며, 아마도 이 글을 보는 것보다 이 글을 작성한 시점보다 좀 더 나아진 기계번역의 힘을 빌리는 것이 좀 더 좋은 방법이라 생각됩니다. June 16, 2023 https://cloud.google.com/blog/products/devops-sre/deep-dive-into-2022-state-of-devops-report-on-documentation?hl=en 기술 조직의 내부 문서는 소프트웨어 개발의 기본적인 부분입니다. 지난 2년 동안 D..
WTD 포틀랜드 2023 - 사용자 피드백을 가지고 문서 개선하기 Ryan Young은 스트라이프 테크니컬 에디터입니다. 스트라이트에서 사용자 피드백을 가지고 어떻게 문서화를 개선했는지 설명합니다. 스트라이프 문서는 사용자가 피드백을 제공할 수 있는 기능을 지원합니다. 이런 피드백을 기반으로 사용자가 작업을 수행하기 위해 필요한 다양한 기능을 추가하고 있습니다. 그럼에도 계속 사용자의 불만은 늘어갔습니다. 그래서 피드백을 천천히 들여다보기 시작했습니다. 그중 하나가 "너무 많은 옵션(Too many options)"을 제공한다는 것이었습니다(문서 시스템의 기능을 이야기하는 건 아니고 제품 자체에서 다양한 옵션을 제공하는데 그런 옵션 설명이 흩어져있다는 것입니다). 그래서 사용자가 필요한 작업을 수행하기 위해 살펴봐야 하는 문서의 내용이 한 곳에 있지 않고 여러 곳에 흩..

반응형