2019-04-12に投稿

すごく短い記事でも大丈夫

記事を書く時、必ずしも頑張って長文の記事に仕立て上げる必要はありません。例えばそもそも、あるエラーに対しての対処方法を書くような記事の場合、無駄に長々と関係のない説明を書いても読むのが辛いだけで本質的ではない場合もあります。ですので例えば、こんな構成の短い記事でも問題ないです。


~~をしていたら下記のようなエラーが出ました。

Error: This is a special error code E2234 (aewfew is undefined)

原因として、~~のライブラリを使っている場合は~~の設定を書いておかないとエラーが発生してしまうため、下記のような設定を追加しておきます。

  setting: true,

こんな感じでも十分です。とにかく書きのこしておいた方が良いかな、と思ったことは短くてもいいのでガンガン記事にしてしまいましょう。もっと深く掘り下げた情報も追記したい、参考となる関連情報も書いておきたい、などがあれば、後で思いついたときにでも追記はできますので。

とくにエラーメッセージはそのものズバリで検索されることもあるので、それと改善方法さえ書いておけば困った人が検索でも引っかかりやすいです。実際に、僕も自分で書いた記事と同じエラーを出して検索し、自分の記事にたどり着いたこともあります。ですので自分のためにも他の人のためにも、とにかく書き残しておきましょう。

ツイッターでシェア
みんなに共有、忘れないようにメモ

view_list [連載] エンジニアのブログ始め方
第3回 基本的な体裁 - 見出しと段落
第4回 プログラムのコードを書こう
第5回 すごく短い記事でも大丈夫
第6回 記事を書くネタの探し方(日常のプログラミングから)
第7回 困っている人がたどり着ける記事にしよう

だら@Crieit開発者

Crieitの開発者です。 Webエンジニアです(在宅)。大体10年ちょい。 記事でわかりにくいところがあればDMで質問していただくか、案件発注してください。 業務依頼、同業種の方からのコンタクトなどお気軽にご連絡ください。 業務経験有:PHP, MySQL, Laravel, React, Flutter, Vue.js, Node, RoR 趣味:Elixir, Phoenix, Nuxt, Express, GCP, AWS等色々 PHPフレームワークちいたんの作者

Crieitは誰でも投稿できるサービスです。 是非記事の投稿をお願いします。どんな軽い内容でも投稿できます。

また、「こんな記事が読みたいけど見つからない!」という方は是非記事投稿リクエストボードへ!

有料記事を販売できるようになりました!

こじんまりと作業ログやメモ、進捗を書き残しておきたい方はボード機能をご利用ください。
ボードとは?

コメント