본문 바로가기

728x90

분류 전체보기

(2452)
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)"을 제공한다는 것이었습니다(문서 시스템의 기능을 이야기하는 건 아니고 제품 자체에서 다양한 옵션을 제공하는데 그런 옵션 설명이 흩어져있다는 것입니다). 그래서 사용자가 필요한 작업을 수행하기 위해 살펴봐야 하는 문서의 내용이 한 곳에 있지 않고 여러 곳에 흩..
2023년 6월 테크니컬 라이팅 이런 저런 소식 6월 14일 9월 10일부터 12일까지 진행되는 WTD ATLANTIC 2023 콘퍼런스 발표자가 확정됐습니다. 9월인데 좀 빠르지 않나 싶은데 발표 준비하는 분들도 시간이 필요하니 그런 듯합니다. ATLANTIC 행사는 오프라인으로는 진행하지 않고 온라인으로만 진행합니다. 온라인이지만 콘퍼런스 참석을 위해서는 참가비를 내고 신청해야 하며 세션 영상은 행사 종료 후 1주일 이후에 유튜브를 통해 공유됩니다. https://www.writethedocs.org/conf/atlantic/2023/news/announcing-speakers/ 6월 16일 데브시스터즈 남정현 님이 지난 8일 CJ올리브네트웍스에서 진행한 강의 사전 질문, 답변을 정리한 문서를 공개했습니다. 강의 때 못다 한 답변을 담은 것이라 부..
구글 검색 첫 페이지가 사라졌습니다 PC에서 사용하는 경우 해당합니다. 아마도 올 초부터 이야기가 나왔었고 일부 적용된 것 같습니다. 저는 이제야 발견했네요(지난주까지는 확실하게 아니었습니다). 검색 결과 페이지를 하단으로 스크롤하면 모바일과 마찬가지로 자동으로 하단에 결과가 이어서 로딩됩니다. 이제 더 이상 첫 페이지가 없는거죠. (물론 스크롤하기 전 보이는 결과라고 할 수는 있겠네요). 무한 로딩 여부는 옵션으로 설정할 수 있습니다. Continuous scrolling(또는 연속 스크롤)을 "사용 안함"으로 설정하면 처음 보이는 결과에서 더 이상 하단에 추가적인 결과를 로딩하지 않습니다. 대신 이전처럼 페이지도 표시하지 않습니다. 그냥 처음 결과 보이고 끝. 아마 순차 적용이라 관련 뉴스는 따로 없는 것 같습니다. 아래 링크 참고하세..
2023년 5월 테크니컬 라이팅 이런 저런 소식 5월 7일 WTD 포틀랜드 2023 행사가 7일부터 9일까지 진행됩니다. 오랜만에 오프라인, 온라인 동시에 진행되는 행사입니다. WTD 슬랙에 행사 사진들도 슬슬 올라오고 있구요. 각 세션 영상은 행사가 끝나면 공유될 예정입니다. 어떤 분위기일지 궁금하네요. https://www.writethedocs.org/conf/portland/2023/ Home | Write the docs Portland 2023 Welcome to Write the Docs Portland 2023- May 01, 2023, Write the Docs

반응형