Technical Writing에 관심을 갖게 되었지만, 당장 뭘 해야 할지 막막한 상황에서 한 글을 보게 되었다.
라인 Technical Writer분이 작성하신 글로, 제목은 '그것이 알고 싶다 - 왜 개발자는 글을 못 쓸까?'.
https://engineering.linecorp.com/ko/blog/why-are-engineers-so-bad-at-writing
전문을 읽어봐도 재밌지만, 나에게 있어 마치 "CTA"같았던 포인트는 '글린이'가 글을 쓰기 위한 첫걸음으로 추천해주신 방법이다. 바로 기술문서를 읽으며 목차 정리하기.
이 방법을 따르기로 결정한 이유와 기대하는 효과는 아래 두 가지이다.
1) IT Background 습득
구글 TW course를 수강하면서도 느꼈지만, Technical Writing이라는 분야 자체가 특히 IT 쪽 수요가 높은 것 같다. 그런 만큼 IT쪽 관련 예시나 교육 문서가 많은데, 이쪽에 대한 Background가 많이 없으니 당장 어휘나 개념부터 몰라서 헤매는 경우가 많았다.
위 글에서 추천해주신 사이트는 대부분 IT 쪽으로, 목차 정리할 겸 그 내용도 일부 같이 훑으면서 통용되는 개념이나 어휘, 관례 등이 눈에 익숙해지길 바란다.
2) 보편적인 문서 작성법 파악
보편적으로 쓰이는 문서 작성법이 있을 것이다. 순서, 내용, 어휘, 예시 등 큰 틀을 익히기 위해 해당 글에서 추천해준 사이트의 문서들을 보면서 목차를 정리해보려고 한다.
물론 모든 내용을 다 옮겨 적지는 않을 것이다. 반복되는 구조는 생략하고, 너무 세세하게 들어가지 않으려고 한다. 글에서 나온 대로 H1~H3 태그 레벨까지 정리하고, 그 이하는 필요시에만 추가하려고 한다.
조금 더 나아가, 가능하다면 각 사이트의 문서를 읽으면서 아쉬운 점과 개선점을 찾아보고, 사이트별 문서를 비교해봐도 좋을 것 같다.
아래는 앞으로 정리할 목록.
노션에서 정리했고, 링크로 첨부했다.
* Stripe API
https://www.notion.so/Stripe-API-21c421e9084980e789a8c2c6996c7fe1?source=copy_link
* NAVER Developers
https://www.notion.so/NAVER-Developers-21c421e9084980f7b784c969dedb38d5?source=copy_link
* LINE Developers
https://www.notion.so/LINE-Developers-21c421e9084980ccacebd9edc18dc86e?source=copy_link
* Android Developers Documentation
* Apple Developer Documentation
* webOS Open Source Edition
https://www.notion.so/webOS-Open-Source-Edition-21c421e90849806bb2c4d7bb2d6abf78?source=copy_link