티스토리 뷰

1월 3일

카카오 엔터프라이즈 테크니컬 라이터 팀에서는 꾸준히 테크니컬 라이팅에 도움이 될 수 있는 글을 공유하고 있습니다. 이번에는 트러블슈팅에 관련된 내용입니다.
국내에서는 "문제 해결"로 번역해 사용하고 있습니다. 카카오 같은 경우도 "카카오 로그인 개발자 문서"에서는 "문제 해결"로 메뉴명을 표시하고 있습니다(하지만 위키피디아에서는 "트러블슈팅"과 "문제 해결" 문서가 따로 있습니다. "트러블슈팅"을 "문제 해결"의 일종으로 구분하고 있네요).
https://developers.kakao.com/docs/latest/ko/kakaologin/trouble-shooting
"...일반적으로 Troubleshooting 가이드는 오류 상황을 나타내는 오류 코드 혹은 오류 메시지, 문제 원인 및 증상, 해결책으로 구성됩니다..."라고 설명하고 있지만 오류 코드나 오류 메시지가 명확하게 나오는 케이스는 좀 더 명확한 문제가 아닌가 싶습니다. 예를 들어 소프트웨어 쪽에서는 에러 코드가 명확하게 나오는 경우가 있지만 장비 같은 경우에는 갑자기 밸브가 흔들리는 문제에 대한 해결도 다루어야 하기 때문에 오류 코드처럼 딱 떨어지는 경우만 있는 건 아닙니다. 
본문에서 예로 든 페이스북이나 AWS 문제 해결 페이지만 보더라도  "Why is my GraphRequest object unresponsive?"처럼 응답이 아예 없는 문제는 어떻게 해결할 수 있는지에 대한 내용을 다루고 있습니다.
https://tech-kakaoenterprise.tistory.com/129

 

https://www.flickr.com/photos/30478819@N08/49990579813

1월 10일

지난해 자바스크립트 기반 정적 사이트 생성기 순위가 공개되었는데요. Docusaurus가 3위라서 깜짝 놀랐습니다. 내용을 보니 순위가 아니라 2021년 깃헙에서 star가 늘어난 것에 대한 순위였군요. 작년에 뜨거웠던 친구들에 대한 순위라고 볼 수 있습니다.

https://risingstars.js.org/2021/en#section-ssg

https://docusaurus.io/

전체 star 순위를 보면 1위는 Next.js, 2위는 Hugo, 3위는 Gatsby 입니다. 참고로 Astro는 2021년 공개됐구요. 다른 라이브러리에서 필요 없는 자바스크립트를 걷어내 웹사이트 속도를 빠르게 만들어주는 것이 특징이라고 합니다.

https://news.hada.io/topic?id=4422

 

1월 13일

아는 분들에겐 별것 아닌 것이지만, 모르는 분들을 위해. 알아두면 좋은 기초 지식 하나.
광주 아파트 붕괴 사고 관련 보도에서, '콘크리트가 덜 마른 채 작업을 했다'라는 식의 보도가 많이 나오고 있는데요. 완전히 잘못된 표현이고, 이런 표현이 오히려 부실공사를 유도할 수도 있습니다.
콘크리트를 '말리면' 절대로 안됩니다.
콘크리트 '양생'은 수분을 말려서 굳히는 게 아닙니다. 점토 공작이나 도자기 만들 때처럼 찰흙을 모양을 낸 후 말려서 굳히는 경험들이 한두번씩은 있으니까 콘크리트도 물을 말려서 굳히는 걸로 오해하는 분들이 있는 건데요. 물을 말려서 굳히는 점토는, (굽지 않는 한) 다시 물에 적시면 또 물렁해집니다. 콘크리트 건물이 비를 맞으면 허물어지면 안되지 않겠습니까?
몰탈(물+시멘트+골재)이 굳은 콘크리트로 변하는 과정을 양생(養生, curing)이라고 하는데, 이것은 물을 말리는 것이 아니라 화학반응의 일종인 수화반응(hydration)입니다.
시멘트의 양생에는 시멘트의 여러 성분들로 인한 몇가지 화학반응이 포함되어 있는데, 그중 가장 주도적인 것은 시멘트에 포함된 산화칼슘(생석회)이 물과 반응해서 수산화칼슘(소석회)으로 바뀌며 굳어지는 것입니다.
https://www.facebook.com/Jeehoon.Imp.Park/posts/4965776393480079

테크니컬 라이터도 비슷한 실수를 할 수 있습니다. 사용자에게 쉽게 설명하기 위해 선택한 용어가 전혀 다른 의미로 해석될 수 있죠. "굳다"와 "마르다"는 전혀 다른 의미를 가지고 있지만 전문 지식이 없이 물컹물컹한 시멘트를 보았다면 저건 "마르다"가 맞다고 생각하고 그렇게 글을 쓰게 됩니다.
해당 기술을 쓰지 않아도 되는 독자라면 아마 비슷하게 생각을 하고 문제가 생기지는 않을 겁니다. 다만 기술을 직접 써야 하는 경우 문서에 쓰인 잘못된 용어는 오류로 이어질 수 있겠죠.

1월 17일

흔하지 않은 테크니컬 라이터 면접(B 회사) 후기입니다.
작년 1월에 공개된 글인데, 왜 이제야 보인 건지는 모르겠습니다만.
대표와 직접 인터뷰를 진행했다는 걸로 보면 스타트업이 아니었을까 싶습니다.
몇 가지 내용은 참고할만합니다.
테크니컬 라이터 조직이 갖추어지지 않은 상태에서 뭔가 조직을 만들어내고 전사에서 역할을 할 사람을 뽑고자 한다면 더 어려운 일이겠죠.

해당 직무는 한국에선 보편적이지 않아서, 적합한 역량을 가진 사람을 뽑기가 쉽지 않고
어떤 기준으로 어떤 사람을 채용해야 할지 시행착오를 겪고 있으며

https://brunch.co.kr/@intj-marketer/17

 

1월 18일

우아한 형제들 DR팀에서 "테크니컬 라이팅 코치" 모집 공고를 올렸습니다.

업무내용을 보면 테크니컬 라이터의 업무와는 다른 듯합니다. 다른 조직에서 테크니컬 라이터가 개발 블로그를 지원하는 경우에는 "플레잉 코치"에 가깝습니다. 기술 문서를 작성하는 업무가 주 업무이고 그 외에는 부 업무에 가깝죠. 하지만 테크니컬 라이팅 코치는 코치가 주 업무입니다.

https://career.woowahan.com/recruitment/R2201039/detail

 

https://career.woowahan.com/recruitment/R2201039/detail

 

1월 25일

주간 인프런은 온라인 강의 플랫폼 인프런에서 보내는 뉴스레터입니다. 이번 주(#40) 주제는 "개발자는 왜 기술 블로그를 쓸까요?"입니다.
"주간 인프런"이지만 매주 발송하는 건 아니고 최근에는 격주 간격으로 보내고 있습니다.

https://www.inflearn.com/pages/weekly-inflearn-40-20220125

 

1월 28일

WTD 2022 포틀랜드 행사는 온라인으로만 진행하기로 결정됐습니다. 작년 말까지만 해도 온오프라인 하이브리드 형태로 진행할 계획이었는데 미국 내 확진자 숫자가 폭증하면서 일정이 변경됐습니다. 혹시라도 컨퍼런스 참석을 계획했던 분들은 참고하세요.

https://www.writethedocs.org/conf/portland/2022/news/conference-going-virtual/

댓글
댓글쓰기 폼