私の技術記事の書き方 - azukiazusaのブログ

技術記事を書くことは、最初はなかなかハードルの高い作業に思えます。文章を書くにはある程度の慣れが必要である考えています。 誰しも初めのうちはうまく文章を書くことができず、文章を書く訓練を重ねることで、内容を伝えやすい・理解しやすいある種の「型」を発見されているのではないかと思っています。 この記事では id:azukiazusa が普段記事を書く時に考えていることを書き下していきます。 見出しを先に書く コードは実行可能にする 文法エラーがないように 文脈依存にならないように foo や bar のような名前を使いすぎない 記事は1日寝かせる その他文法的な事項 見出しは ## から始める インラインコードブロックは装飾目的で使わない 英語と日本語の間に半角スペースを空ける おわりに 参考 見出しを先に書く 私が技術記事を書くときには最初に見出しから書き始めます。下記のような感じです。 見

[yarumato]

“英語と日本語の間に半角スペースを空けると読みやすい...(?)”　印刷の世界では 「半角スペース入れるな。入れたら削除する」と前から言われている。 https://www.dtp-transit.jp/misc/writing/post_664.html

[koogawa]

とても共感。“英語と日本語の間に半角スペースを空ける” これは最近ブラウザ側が良い感じに調整してくれるようになったので空けなくなった

[kazkaz03]

半角スペース入れないとたまに改行おかしくなる場合がある

[Windymelt]

良い

[motch1cm]

英語と日本語の間に半角スペースを入れるの、たまに抜けている時があるので何とかしたい。lint使えという話ですが…。

[Nobkz]

私のやってるのと真逆だなー。最初から書きたいものがあるのではなくて、私の場合、寝かせないし、なんなら書いてる途中を出すし、書いてたら書きたいやつが出でくる感じ。

[hara_boon]

“英語と日本語の間に半角スペースを空ける” 全体的に有用だけど、これ今更どうなんってずっと思ってる。どんなビューワーでもだいたい見やすくない？

[takilog]

いいテクがまとまってる

[mizdra]

良い

[yujiorama]

考えさせられる。意図しない広告の差し込みが無視できないので、先頭にabstractやキーワードや参考情報をまとめるようにしようかな