湊川流、文章ビフォーアフター術①「だから何?」
https://gyazo.com/ca5a67f503f119370119d44d3e5be730
目的:Git公式ドキュメントをわかりやすくしてみよう!
leaf.iconBefore
Git にコミットした内容のすべては、ほぼ常に取り消しが可能であることを覚えておきましょう。削除したブランチへのコミットや --amend コミットで上書きされた元のコミットでさえも復旧することができます (データの復元方法については 第 9 章 を参照ください)。しかし、まだコミットしていない内容を失ってしまうと、それは二度と取り戻せません。
leaf.iconAfter
# コミットさえしていれば、いくらでもやり直せる!
Gitにコミットした内容は、ほとんどの場合、やり直しがききます。
逆に言えば、コミットしていなければ、二度とやり直せません。
こまめにコミットするように心がけましょう。
https://gyazo.com/66eb747349b9bf8f974227cfb4689a68
leaf.iconやったこと
Gitにコミットした内容は、取り消せる
コミットさえしていれば、復旧できる
逆に、コミットしていなければ、その内容は二度と取り戻せない
▼骨を抜き出しながら、頭の中ではこういうことを考える
「取り消す」「復旧する」「取り戻す」などと、似たようで少しニュアンスの違う言葉が混在しているので、整理したいなぁ
ページタイトルが「やり直し」という言葉を使っているので、「やり直し」にそろえてみようかなぁ
たとえば、この文章は正しい内容ではあるが、現段階でここまで詳細な説明は必要ない。
9章の話も、あとで関連リンクとしてまとめたほうがスッキリするし、わざわざ今言及する必要はないと考える。
削除したブランチへのコミットや --amend コミットで上書きされた元のコミットでさえも復旧することができます (データの復元方法については 第 9 章 を参照ください)。
②推敲する
Gitにコミットした内容は、ほとんどの場合、やり直しがききます。
逆に言えば、コミットしていなければ、二度とやり直せません。
箇条書きを文章化する。それと同時に、単語も推敲する。
③「だから、何?」をプラスする
Gitにコミットした内容は、ほとんどの場合、やり直しがききます。
逆に言えば、コミットしていなければ、二度とやり直せません。
こまめにコミットするように心がけましょう。
読者が知りたいのは「で、どうすればいいの?」ということなので、結論を端的に書く
④結論をひとことで表す見出しをつけると、より親切
# コミットさえしていれば、いくらでもやり直せる!
Gitにコミットした内容は、ほとんどの場合、やり直しがききます。
逆に言えば、コミットしていなければ、二度とやり直せません。
こまめにコミットするように心がけましょう。
湊川の場合、「だから、何?」の部分を見出しにすることが多い
※諸注意
これは、湊川がどのように思考したかのメモ書きで、随時更新されます。
引用元の文章に対する批判ではありません。単に個人のトレーニングのための題材として引用させていただいています。
「わかりやすい文章」は、人の数ほど/目的の数ほど正解があります。皆さんも一緒にレッツ推敲!
推敲とはなんたるかを教えてくれる書籍
私が解説文を書くときのすべてのベースになっている本です。
以下の結城先生のツイートから、第1章が無料で読めます。
関連書籍
https://gyazo.com/126e9f1ca7a6b3bd745e07866e0a118a
https://gyazo.com/936b08717df2eec6c22fca00601b94de
https://gyazo.com/ea1c0aaeeb787405a7e5b032c51d09e8
書いた人: llminatoll.icon #湊川あい