기술 자료 작성

이러한 질문은 기술 문서 작성에 관여하는 응답자에게만 표시되었습니다.

전체 응답자의 12%는 기술 문서 작성에 참여하고 있다고 답했습니다. 그 중 10%만이 테크니컬 라이터로서 공식적 직무를 맡고 있습니다.

즉, 2023년 JetBrains 개발자 에코시스템 현황에서는 문서를 작성하는 사람 중 90%가 스스로를 테크니컬 라이터라고 부르지 않으며, 이는 팀 간의 공동 작업, 문서 품질 및 일관성, 테크니컬 라이터의 역할에 대한 질문을 제기시킵니다.

어떤 유형의 문서를 작성하시나요?

대부분의 응답자는 내부 및 코드 문서 작업을 수행합니다. 작년 이후로 고객용 문서 작업을 수행하는 사람의 비율이 4% 감소했습니다.

문서 작성 도구

사용자 지정 가능한 텍스트 에디터는 여전히 문서 작성자의 선택을 받는 도구입니다. 가볍고 유연하며 효율적인 텍스트 및 코드 편집 수단을 제공하므로 문서 작성에 특히 적합합니다.<0/><1/>그러나 올해에는 사용자 지정 가능한 텍스트 에디터의 사용이 7% 감소했고, 동시에 GitHub 페이지에서는 거의 동일하게 6%가 상승했습니다. 한편, 공동 위키 문서화의 대표적인 사례인 Confluence는 그 위치를 유지했습니다.

문서 작성에 사용하는 도구는 무엇인가요?

어떤 전문적인 도움말 작성 솔루션을 사용하시나요?

전문적인 도움말 작성 솔루션을 사용한다고 답한 3%의 응답자 중 42%는 맞춤형 도구를 선호합니다. 나머지 옵션 중에서 눈에 띄는 유일한 최신 도구는 점유율이 5%인 Paligo입니다. 다른 인기 옵션은 모두 기존에 잘 알려진 도구입니다.

현재 솔루션에 만족하시나요?

도움말 작성 도구를 사용하는 사람들 중 무려 30%가 더 나은 것을 찾고 있습니다.

기술 자료 작성을 위한 전문 도구 사용을 고려해본 적이 있으신가요?

기술 문서 작성에 참여하는 사람들 중 절반 이상이 전문 도구의 사용을 생각해 본 적이 없지만, 무려 45%가 이용 가능성에 문을 열어두고 있습니다.

마크업

Markdown에 대한 선택이 여전히 우세합니다. 그러나 작년과 비교하면 표준 Markdown(7% 감소) 및 Markdown 버전(4% 감소)에서 WYSIWYG 및 Office 유사 애플리케이션(6% 증가)으로의 전환이 분명하게 드러납니다. 소스에 대한 통제력이 편의성이나 사용자 친화성보다 뒷전으로 밀리고 있음을 의미하는 것일까요?

의견을 공유하세요

기술 문서 작성에 사용하는 마크업 언어는 무엇인가요?

콘텐츠 재사용 및 템플릿

응답자의 거의 절반이 콘텐츠 재사용에 구조화된 접근 방식을 이용합니다. 그러나 32%는 여전히 복사하여 붙여넣기 방식을 따르는데, 이는 아마도 사용 중인 도구의 한계 때문인 것으로 보이며 이로 인해 불일치가 발생하고 문서 작성 프로세스가 느려질 수 있습니다.

다양한 문서/가이드에서 내용을 재사용하시나요?

작성 프로세스의 속도를 높이기 위해 템플릿을 사용하시나요?

어떤 종류의 템플릿을 구성하시나요?

매개변수화된 템플릿(예: 변수가 포함된 템플릿)을 만드시나요?

응답자의 69%는 작성 속도를 높이기 위해 템플릿을 사용하지 않지만, 그렇게 하는 응답자 중 대부분은 다양한 문서 유형에 템플릿을 사용합니다. 변수가 포함된 동적 템플릿에 대해서는 의견이 크게 갈립니다.

자동화된 검사 및 문서 품질

응답자의 13%만이 기술 문서에서 자동화된 검사를 사용합니다. 대다수는 공개 Linter를 사용하기보다는 사내에서 테스트를 작성합니다. 아마도 테스트가 손상된 마크업, 링크 및 참조를 대상으로 하기 때문일 것입니다. 언어 및 스타일 검사에는 내장된 철자 검사기가 주로 사용됩니다.

기술 문서에 자동 검사를 사용하시나요?

어떤 유형의 검사가 있나요?

언어/스타일 검사를 자동화하시나요?

API 문서

응답자의 절반 이상이 API 참조를 작성합니다. 개발자가 이를 주도하고 있으며 81%가 API 참조를 작성한다고 답했습니다. 아키텍트(19%), 테크니컬 라이터(18%), DevOps 엔지니어(17%) 등의 역할이 그 뒤를 이었습니다. 다른 직무 역할은 이 작업에 잘 참여하지 않으며 CIO, CEO, CTO와 같은 고위직은 이 활동에 관여하는 비율이 적습니다(7%).