Technical writing resources

このページでは、その他のテクニカルライティングリソースをまとめます。

Editorial style guides

編集スタイルガイドは、編集グループのコミュニケーションに関するガイドラインについて定義しています。 例えば、あなたの組織は見出しについて、次のどのルールを採用すべきですか？

• 見出しを文のケースに入れる（各見出しの最初の単語のみを大文字）
• 見出しをタイトルケースに入れる（各見出しのほとんどの単語を大文字）

この種の質問について議論する時間とエネルギーを浪費しないでください。その代わりに、特定の編集スタイルガイドを採用するように組織に依頼するだけです。編集スタイルガイドは、文章の選択に関する質問に対する一連の答えを提供します。 ある編集スタイルガイドが文の大文字を推奨し、別の編集スタイルガイドがタイトルの大文字を好むことは重要ではありません。 しかし、エンジニアリングチームは、テクニカルライティングに特化したエディトリアルスタイルガイドを使用する必要があります。

• The Google developer documentation style guideは、Google関連プロジェクトの開発者向けドキュメントを書く人のための編集ガイドラインです。
• The Microsoft Writing Style Guideは、技術ドキュメントを書く人のためのガイドラインです。 ハウス “エディトリアルスタイルガイドを作成し、維持するには、膨大なリソースが必要であり、途方もない紛争を引き起こす。 とはいえ、組織によっては、既存のエディトリアルスタイルガイドにない新しい用語が生まれることもあります。 このような場合、組織は次のいずれかを行うことができます。
  • 新しい用語を追加するために編集スタイルガイドのメンテナを依頼する。
  • 組織の専門用語のスペルと単語の用法を成文化する独自の使用ガイドまたはスタイルシートを作成し、維持する。