文章を補足する

ドキュメントで本文を書いていると、補足したいことがある。基本的には以下のパターンにする。

パスタをソースと絡めたら、オリーブオイルを一回しする。
※ 最後にオリーブオイルをかけるのは、風味をいかすため。

理由は2つある。 1.本文と注釈を明確に分けたい 2.丸括弧は、他の仕事が沢山あるので担当を減らしたい

1.について

事実と意見を明確に分けるのが基本であると、これまでにも説明してきた。

同じように、マニュアルのようなドキュメントでは、実際に手を動かす本文と、知っているとお得な情報(注釈や補足)は明確に分離されるべきだ。この「※」は、文頭にある時に脚注や注釈を意味する記号である。これを使うことで、本文と注釈を明確に分離できるわけ。

2.について

丸括弧にはたくさんの役割がある。例えば、以下のような。

丸括弧を使うことで、本文中で直前の語を、短く補足できる。とはいえ、文中で丸括弧を連発されると読みづらくてうざったいので、スパイス的にちょっと使うとよい。

丸括弧で長く補足するのはNGだ。読みづらいので、別の文章とし分離すべき。素人は、丸括弧を適当に使いがちである。

パスタをソースと絡めたら、オリーブオイルを一回しする。(最後にオリーブオイルをかけるのは、風味をいかすため。)

基本的に、丸括弧は本文中の補足として存在するもので、別の文として現れると奇妙に感じる。補足として分けたいなら改行すべきだし、本文の一部にしたいなら丸括弧を外せばいい。なんとも煮えきらない書き方になってしまっている。さらっと書きたいなら、

パスタをソースと絡めたら、オリーブオイルを一回しする。最後にオリーブオイルをかけるのは、風味をいかすため。

とか

パスタをソースと絡めたら、オリーブオイルを一回しする(風味をいかすため)。

という形になるだろう。

ただドキュメントであるなら、米注で明確に分離した方が読み取りやすし、読まないという判断もし易い。