Deanna Thompson은 Tech Elevator의 테크니컬 라이터입니다.
Tech elevator는 코드스테이츠와 비슷한 교육기관인데 로컬 기반이라고 하네요. 미국은 워낙 땅이 크니깐 이런 비즈니스도 가능한가 봅니다. 뭐 하여간 이런 곳에서 테크니컬 라이터는 뭘 할까 싶었는데 커리큘럼 개발 팀에서 일한다고 합니다. 학생이나 강사를 위한 학습 자료를 만들고 퀴즈도 만드는 것을 지원하네요.
Building a style guide from the ground up:
lessons learned from a lone writer
일단 조직 내에서 유일한 테크니컬 라이터이고, 모든 콘텐츠를 직접 만드는 것은 아니라서 콘텐츠를 만드는 것을 지원하거나 프로젝트에 따라 참여해서 작업을 진행한다고 합니다.
조직에 합류하기 전에는 테크니컬 라이터가 없었고(아마도) 자체적인 스타일 가이드가 없어서 구글 개발자 문서 스타일 가이드를 참고했습니다. 구글 스타일 가이드가 범용적이고 많은 내용을 담고 있지만 모든 상황에 딱 맞는 문서는 아닙니다. 때문에 문서에 적용된 스타일에 제각각이었고 이런 문제를 해결하기 위한 방안으로 맞춤형 스타일 가이드가 필요했습니다.
특히 이곳에서는 교육을 위한 자료를 강사가 만들어야 하는데, 그에 맞는 가이드가 필요했던 것이죠.
그래서 구글 스타일 가이드를 활용하면서 사용자들이 쉽게 접근해서 바로 사용할 수 있는 가이드를 만들기로 했습니다.
(일반적인 소프트웨어 관련 문서라면 구글 스타일 가이드로도 충분할 수 있습니다. 발표자가 속한 조직에서 필요한 콘텐츠는 맞춤형 가이드가 필요했을 뿐이죠).
그래서 스타일 가이드를 만드는 여정을 쭉 돌아보는 이야기를 공유합니다.
흥미로운 건 THE GOOD DOCS PROJECT라는 프로젝트입니다. 오픈 소스 진영 커뮤니티에서 가이드 문서 작성을 돕기 위해 만든 템플릿 사이트입니다. 글 제목은 바닥부터 만들기라고 했지만, 실제로는 그럴 필요는 없다는 거죠. 누군가 공유한 좋은 템플릿이 있다면 가능한 활용해보자입니다.
https://thegooddocsproject.dev/
The Good Docs Project
Templates to make good docs.
thegooddocsproject.dev
스타일 가이드를 위한 템플릿도 있어서 새롭게 문서를 만들지 않고 템플릿을 사용해서 내용을 채워가는 식으로 진행했다고 합니다.
Good Docs - Style Guide
Project Name Style Guide [When do you need a style guide?] [How to Make a Style Guide Scale with Your Project] Introduction Our Preferred Style Guide Glossary of Preferred Terms Topic Types and Templates General Writ...
docs.google.com
스타일 가이드 만드는 일은 간단해 보이지만 대부분의 경우 기존의 업무와 같이 진행하고 다양한 이해관계자의 피드백을 받고 반영하는 일이 반복되어야 하기 때문에 상당히 많은 시간을 필요로 한다고 합니다. 그래서 스타일 가이드를 만들기로 했다면 여유를 가지고 진행하는 것을 권장하고요.
