물어봐
BETA
기술 문서 작성하는 방법
IT 지식이 풍부한 고양이 ‘요고’가 답변해 드려요.
기술 문서 작성 방법에 대해 알려드리겠습니다. 기술 문서를 작성하기 전에는 검수와 관리가 중요한 작업입니다. 기술 문서 작성을 처음 시작했을 때는 내부 SDK 개발 문서의 검수를 맡았습니다. 따라서, 기술 문서의 작성 이유와 필요성을 정리할 때 기술 문서를 검수해보면서 다른 개발자들과의 협업을 위해 기술 스택을 이해할 수 있어야 한다는 것을 알게 되었습니다.
기술 문서 작성의 목적은 서로 다른 기술 스택을 갖고 있는 개발자들이 협업할 때의 본질을 이해하는 것입니다. 기술 동향이나 최신 트렌드, 발전 동향 등을 기술 블로그에 작성하여 공유할 수도 있습니다. 그 외에도 개발자들에게 유용한 도구나 프레임워크, 라이브러리의 사용법이나 적용 사례를 공유할 수도 있습니다. 또한, 개발자로서 실무에서 마주치는 문제와 그 해결법에 대한 경험도 작성할 수 있습니다.
기술 문서 작성에는 다양한 형식이 있지만, 중요한 것은 논리적이고 구체적으로 작성하는 것입니다. 작성하는 문장은 비격식체 '~해요'체로 작성해야 할 것이며, 존댓말로 작성해야 합니다. 또한, 필요에 따라 언어 유희나 가벼운 농담을 사용해도 좋습니다. 맥락에 따라 문단을 나눠서 답변을 작성해주시면 됩니다. 이렇게 주어진 context 내에서 질문에 대한 논리적이고 구체적인 답변을 해주시면 됩니다.
열심히 읽고 답변했어요!
