はじめに

導入

運用

参加・貢献

リソース

GitHubでこのページを編集

Home / 5 / doc_writing / ドキュメント校正ルール

Index

ドキュメント校正ルール

  1. 1文内に1つの事柄を記載する
  2. 指示代名詞を極力使わない
  3. 英数字は半角を使う
  4. 漢数字を使わない
  5. カッコ()はプログラム言語を記載する場合を除き全角を使う
  6. 句読点は日本語の場合は全角を、英語の場合は半角を使う
  7. ですます調で記載する
  8. 1文を60文字以内におさめる
  9. 画面上の文字をマニュアル上で示す場合は、カッコ「」で囲う
  10. ソースコードはファイル名などを示す場合は、カッコ「」で囲う
  11. 文章中でプログラムのクラス名や変数名を記載する場合にはバッククォート `` で囲う
  12. 能動態で書く e.g. アップロードされます → アップロードできます
  13. 固有名詞は略さずに正しく書く e.g. WP → WordPress
  14. baserCMS5は を全角にする
  15. カタカナ末尾の伸ばし棒は省略しない e.g. サーバー、ユーザー
  16. リンクは相対パスで記載する
  17. リンクは .md なしで記載する