技術ドキュメントの作成

共有:

これらの質問は、技術ドキュメントの作成に従事している回答者のみに提示されました。

アンケート回答者の 12% が技術ドキュメントの作成に関与していると答えました。ただし、技術ドキュメントの作成を正式な職務としていたのはその中の 9% のみです。

職務を問う質問では、回答者は複数の選択肢を選択できました。

どのようなドキュメントを作成していますか?

86%

社内ドキュメント

61%

コードドキュメント

57%

顧客向けドキュメント

1%

その他

顧客向けのドキュメントを作成している開発者の数は昨年比で 5 パーセントポイント増加しています。

ドキュメントの作成にはどのツールを使用していますか?

46%

カスタマイズ可能なテキストエディター 

32%

Confluence

28%

Office アプリケーション

24%

GitHub Pages

24%

Google ドキュメント

21%

Wiki プラットフォーム

2%

ヘルプ作成専用ツール

15%

その他

2%

なし

docs-as-code アプローチの人気が高まっており、ドキュメント作成用の開発者ツールを使用する人が増えています。正確には、2021 年に比べて 6 パーセントポイント増加しています。

技術ドキュメントの作成にはどのマークアップ言語を使用していますか?

77%

Markdown

18%

分からない / WYSIWYG エディターまたは Office 系のアプリケーション

13%

カスタムの Markdown フレーバー

5%

AsciiDoc

5%

XML / DITA / DocBook など

4%

reStructuredText

4%

その他

Markdown が依然として最も一般的なマークアップ言語となっています。技術ドキュメントの作成に従事する人の 13% がカスタムの Markdown フレーバーを使用して基本機能を拡張しています。

ドキュメント / ガイド間でコンテンツを再利用していますか?

42%

はい。再利用可能なコンテンツをスニペットとして保存し、さまざまなドキュメントから参照している

37%

いいえ。使用しているツールでは単一ソースがサポートされていないため、似たようなコンテンツをコピーして貼り付けている

20%

いいえ。コンテンツを再利用する必要はない

回答者の 80% はコンテンツを再利用する必要があるにもかかわらず、似たようなコンテンツを未だに手作業でコピーして貼り付けています。

6%

ドキュメント作成者のうち、ドキュメントチェックを自動化している人の割合。破損したマークアップ、外部リンク、およびコードサンプルのチェックが最も一般的に使用されているテストです。興味深いことに、10% は言語チェックも自動化しています。

58%

API のドキュメント化を必要としている人の割合。61% が API ドキュメントを自動生成しており、大抵は Swagger を使用しています。

30%

テンプレートを構成して日常業務を自動化している人の割合。各種のトピック、ドキュメント、および繰り返し使用されるコンテンツをほぼ自動化しています。

テンプレートの構成対象になるものには何がありますか?

74%

各種のトピック/ドキュメント

46%

警告ブロックのような繰り返し出現するコンテンツ

26%

複雑なマークアップ要素

47%

テンプレートを使用する人のうち、パラメーター化されたテンプレートを作成している人の割合。

ドキュメントを作成する際の主要言語は何ですか?

63%

英語

22%

中国語

6%

日本語

1%

フランス語

1%

韓国語

1%

ロシア語

6%

その他

技術ドキュメントで最も一般的な主要言語の中では英語のシェアが圧倒的です。中国語は大差で 2 位に入っています。

68%

技術ドキュメントの作成にプロ仕様のツールの使用を検討したことがあるテクニカルライターの割合。

技術ドキュメントの作成にプロ仕様のツールの使用を検討したことはありますか?

68%

45%

はい

32%

55%

いいえ

技術ドキュメントの作成に従事している全回答者の 13% はすでにドキュメントを別の言語にローカライズしており、10% はその予定があります。

WritersideEAP

ドキュメント作成にプロ仕様のツールを検討している 68% に該当していますか?

早期アクセスプログラムに参加し、技術文書作成用の新しいツールをお試しください。

  • IntelliJ ベースの IDE と連携します。
  • Markdown、セマンティックマークアップ、およびそれらの組み合わせをサポートします。
  • ドキュメントの高品質な自動化向けに 100 個以上のテストが組み込まれています。
  • 条件と変数を用いたコンテンツの再利用をサポートしています。
  • 各種コンテンツタイプと複雑なマークアップ要素に対応したテンプレートが組み込まれています。
技術ドキュメントの作成:

2022

最後までご覧いただきありがとうございました!

レポートはお役に立ちましたか?
ぜひこのレポートを友人や同僚と共有してください。

ご質問やご提案がございましたら、surveys@jetbrains.comまでお問合わせください。