仕事柄，技術的な用語を含んだプレーンテキスト（メール，ドキュメント，Wiki, etc）を書くことが多いわけですが，そのうち日本語の文章を書くときに自分が意識している "形式" に関してまとめてみます．
あくまで，自分が意識的に気をつけていることを明文化してみようというただの備忘録で，文章とはこう書くべきというのを述べたいわけではありません．むしろ他の方のこだわりを聞いてみたい．
これはただの好み
- 句読点にはコンマ（，）とピリオド（．）を用いる
- カタカナ用語は JIS 規格のあれ（コンピュータ，エクスプローラ，ディレクトリ，フォルダ，etc）
日本語とアルファベットの間は半角スペースを開ける
私の好きなプログラミング言語は Ruby です
ただし，数字の扱いはあやふや（気分によりけり）
リストから要素を 1 つ選ぶ
リストから要素を1つ選ぶ
句読点の全角半角は直前の文字に合わせる
最近，趣味では Python, Go を書くことが多いです．
固有名詞は勝手にアレンジしない
o Jenkins を起動します
o GitHub にアクセスしてください
x haskell を学習中に挫折した
x 好きな linux ディストリビューションは manjaro です
要するにできるだけ正式な表記を使いたいということ．
当然，git コマンド とか Python はパイソンと読みます という文脈では git や パイソン と表記する．
カタカナで表現できるものを英語にしない
＃ これは私の働いている会社でやたら多く見かける
修正を commit して build 可否を確認し package を作ります
Jenkins master の IP Address は xxx です
修正をコミットしてビルド可否を確認しパッケージを作ります
Jenkins マスタの IP アドレスは xxx です
順序が関係する列挙は (1), (2), ... を用いる
このアプリケーションをビルドするには，以下の手順が必要です
(1) xxx でアカウントを作成し SDK をダウンロードする
(2) 必要なソフトウェアをインストールする
(3) yyy コマンドを実行する
(4) ...
順序が関係ない列挙は (a), (b), ... または - を用いる
利用可能なテキストエディタ
- Vim
- Emacs
- nano
とくに，後ろの文章で選択肢を参照する必要があるときは，(a), (b), ... を用いることが多い．
以下の修正案があります
(a) ...
(b) ...
(a) の場合は高パフォーマンスが期待できますが，実装コストが高そうです．
...
カッコは中身によって使い分ける
半角文字だけなら半角を，
macOS (Catalina)
それ以外の場合は全角を用いる
人気の IDE（例えば Visual Studio Code）
＃ ほかにもまだありそう