テキストでのメモは書く人多いと思いますが、書き方は千差万別です。 この辺りは「業界スタンダードの方法」というのは無いのかな？とは感じます。エンジニア寄りの人間であれば、Markdown形式で書く人も多いかなとは感じます。
日本語の場合、ずばりそのメモの書き方で割と綺麗に書ける方法があるので、その秘密のテクニックをご紹介。
Markdownをそのまま貼り付けてしまう残念な人たち
Markdownは素晴らしいフォーマットです。 ドキュメントを簡単に直感的に構造化できます。 まさにこのブログも今Markdownフォーマットで書いています。
しかしながら、最近周りのエンジニアで見かけるのが、この生のMarkdown形式で、直接メールなどにテキストを添付して送付する人たちです。
# 開発グループ
## 本日の作業予定
+ 仕様書作成
+ MTG1件
- 定例MTG
## 障害になっていること
+ 予期せぬ障害対応で時間が取られてしまいプロジェクトが遅れた
# 営業グループ
## 本日の作業予定
+ 仕様書作成
+ MTG1件
- 定例MTG
...
こんな文書、受信した側が読む気がすると思って送っているのでしょうか。私は読まずに即アーカイブ行きです。MarkdownをMarkdownとしてプレビューが無い環境で見るのが前提であれば、やはり見やすいテキストのフォーマットで送るのが丁寧な仕事の対応といえます。
書き方サンプル
私がよく使っているサンプルを書いてみましたので、以下に記載。見たそのままです。
＜メモについて現状の問題＞
■そもそもの問題点
・プレーンテキストで見やすく書くのが難しい
・たまにHTMLなどを使ってリッチテキストで書いている人がいる
⇒ 手っ取り早く綺麗には書ける
⇒ しかし、テキストとしてコピペすると構造化情報が失われてしまう
■Markdown問題
・エンジニアはよくMarkdownで書いている
・そのMarkdownをそのままメールに貼り付け、送付している人が多い
・そもそも生のMarkdownは直接テキストのまま読むことを前提としていない
＜良い書き方＞
■ヴィジュアル面で見やすい
■書きやすい
■グルーピングし易い
PowerPointのようなリスト表記で、さらに字下げ出来る仕組みが経験的に綺麗に書けます。これを、以下の組み合わせで表現します。
- Level1: ＜＞
- Level2: ■
- Level3: ・
- Level4: ⇒
半角スペースを連結して利用すると、環境によっては崩れてしまうので、全角スペースをインデントとして活用します。全角スペースもかなり便利です。
秘密のテクニック
簡単に構造化するテクニックがあります。それはGoogleIMEなどの辞書機能の活用です。
| 変換元文字 | 変換先 | 備考 |
|---|---|---|
| ＜ | ＜＞ | - |
| ｓ(全角) | [全角スペース]■ | しかく |
| ・(全角) | [全角スペース][全角スペース]・ | - |
| ｙ(全角) | [全角スペース][全角スペース][全角スペース]⇒ | やじるし |
これを準備しておけば超簡単に構造化したドキュメントを書くことが出来ます。 パワーポイント上でしか成し得なかったテクニックが、メモ帳で簡単に再現が可能です。
このテクニックを使うことで、構造化された文書をバンバン書けるようになり、 羨望の眼差しを手に入れられることでしょう。
最後に
私の秘密のテクニックを紹介してしまいました。 もし皆様も良いテクニックがあれば、私のTwitter宛までこっそりご紹介下さい。
