기술 자료 작성
공유하기:
이러한 질문은 기술 문서 작성에 관여하는 응답자에게만 표시되었습니다.
설문 응답자의 12%는 기술 문서 작성에 관여하고 있다고 말했지만 9%만이 기술 문서 작성을 공식적인 직무로 하고 있습니다.
직무에 대한 질문에 응답한 사람들은 하나 이상의 옵션을 선택할 수 있었습니다.
내부 문서
코드 문서
고객 문서
기타
작년과 비교하여 고객 대면 문서를 작성하는 개발자 수가 5% 증가했습니다.
더 많은 사람들이 문서 작성을 위해 개발자 도구를 사용함에 따라 코드로 문서를 작성하는 접근 방식이 인기를 얻고 있습니다. 정확히는 2021년보다 6% 증가했습니다.
Markdown은 여전히 가장 인기 있는 마크업 언어이며, 기술 문서 작성에 참여하는 사람 중 13%는 기본 기능을 강화하기 위해 사용자 정의 Markdown 버전을 사용합니다.
예. 재사용 가능한 내용을 스니펫에 저장하고 서로 다른 문서에서 참조합니다
아니요. 사용 중인 도구는 단일 소스를 지원하지 않으므로 유사한 내용을 복사하여 붙여넣습니다
아니요. 내용을 재사용할 필요가 없습니다
응답자의 80%가 콘텐츠를 재사용해야 하며 1/3 이상은 유사한 콘텐츠를 여전히 수동으로 복사하여 붙여넣습니다.
6%
문서를 작성하는 사람들 중 문서 검사를 자동화한다고 응답한 비율(손상된 마크업, 외부 링크 및 코드 샘플에 가장 인기 있는 테스트 사용). 흥미롭게도 10%는 언어 검사도 자동화합니다.
58%
API를 문서화해야 하는 비율. 응답자의 61%가 API 문서를 자동 생성하며 대부분의 경우 Swagger 사용을 선택합니다.
30%
주로 다양한 유형의 주제, 문서 및 반복 콘텐츠를 자동화하는 템플릿을 구성하여 일상적인 작업을 자동화합니다.
다양한 유형의 주제/문서
경고 블록과 같은 반복 콘텐츠
복잡한 마크업 요소
47%
템플릿을 사용하는 사람들 중 매개변수화된 템플릿을 생성하는 비율.
영어는 지금까지 기술 문서에 가장 널리 사용되는 기본 언어입니다. 큰 격차를 두고 중국어가 두 번째를 차지합니다.
68%
기술 전문 저술가 중 기술 문서 작성에 전문적인 도구 사용을 고려했다고 응답한 사람의 비율.
68%
45%
예
32%
55%
아니요
기술 문서 작성에 관련된 모든 응답자의 13%는 이미 문서를 다른 언어로 현지화했으며 10%는 그렇게 할 계획입니다.
WritersideEAP
문서 작성을 위한 전문 도구를 고려하고 있는 68%에 귀하도 속한다고 생각하시나요?
얼리 액세스 프로그램에 참여하여 다음의 기능을 제공하는 기술 문서 작성용 새로운 도구를 사용해 보세요.
- IntelliJ 기반 IDE와 호환됩니다.
- Markdown, 시맨틱 마크업 및 이 둘의 조합을 지원합니다.
- 문서 품질 자동화를 위한 100개 이상의 기본 제공 테스트가 있습니다.
- 조건 및 변수를 이용한 콘텐츠의 재사용을 지원합니다.
- 다양한 콘텐츠 유형 및 복잡한 마크업 요소에 대한 템플릿을 기본 제공합니다.
읽어주셔서 감사합니다!
이 보고서가 여러분에게 도움이 되었길 바랍니다. 이 보고서를 친구와 동료에게 공유하세요.
질문이나 제안이 있으면 surveys@jetbrains.com으로 연락해 주세요.