やまろぐはてな

yamanokuの技術メモとか戯言。真面目に見たり見なかったりしてください

記事を書くときに気をつけること

自分が所属している会社もこないだからQiita Organizationに参加して各自記事をアップしたりしています

qiita.com

こういうところに書くのも日々のモチベや多忙さに左右されるので継続は難しいなと感じるところですが、記事を共有するというのは慣れていないとどうも参入障壁がデカい気がします(いわゆるアウトプットが慣れてない場合)

そんな訳で少しでも参入障壁や苦手意識を取っ払うために自分の中で記事を共有するときに念頭においてることを以下書いてみます

重複する内容じゃないか

これは当たり前ですが既に世に出ているものでそれが十分だったらそれでいい訳です。いわゆる新規性がまったくない場合

もし間違ってたりアップデートしている内容があったら編集リクエストなり指摘を入れればよくて(直すかどうかはおいておき)、わざわざ自分が書くことはないと思います。それでも残したいならメモ帳にでも書いとけ

既存のものを組み合わてみる

もしかしたら大半のことは上記のことで弾かれてしまうと思いますが、別にそれは単一の内容だから被ってしまうのではと思います

いわゆる「点と点をつなげたもの」を調べてみるといいです

例えばバグをみつけて改修するときに、それに基づく情報やtipsがあったとして、そこに行き着くまでに試したことやダメだったことは一つの財産たるわけです

簡単に直せることはもちろん大事ですが、そこに行き着くまでのプロセスや何故こうしたらできたのか、ということを知ることが一番大切です。

そうした結果に行き着くまでのいくつもの点をつなげてみると、より洗練されたものになるのではないでしょうか

qiita.com

日本語情報があるか

ここら辺は有志がwikiなりしかるべき場所にまとめたりしてますが、無かったら書くに値するかなと感じます

少なくとも検索かけて1、2ページに有効な手や翻訳記事がなかったら共有する価値は十分あるかなと思います

結構プロジェクトによっては、とあるバージョンのまま日本語記事が書かれていない場合もあったりします。

qiita.com

実際に試した内容か

正直tipsをこういうのがあるよ!と言って書いたりすることもありますが、ブラウザの互換性やバージョン、バグらへんを完全に無視したものもあったりしてそれはノイズとなんら違わないです

なので実際にやってみた雑感なり、ここを対応するときは注意みたいなことを追加で書いておくだけでだいぶ優しい記事になりえると思います

試した結果とかはjsfiddleとかcodepenとか実際のプロジェクトに置いて各自で試してもらうなど、形として残しておくとなお良いかと思います

qiita.com

試した・変えてみたことがどうなったか

色々な実験や改善策、アップデートが日々行われているとは思いますが、そうした試してみた結果、どういう現状になったかというのは一つのネタになり得ます

もちろん上手くいくことがすべてではなく、失敗して共有すらできないこともあるかと思いますが、できる限り咀嚼してみて同じ轍を踏まないようにしてあげる(たとえ届かなくても)のも、業界全体を良くすることだと思えば価値はあるかなと思います

yamanoku.hatenablog.com

yamanoku.hatenablog.com

個人でやってみたこと、社内で試したこと

ここら辺は場合によっては書ける書けないの領域もあるかとは思いますが、ネタとしては使えるものもあったりします

たとえば「社内でこうしたツールを使ってみたけどもっと使いやすくしてみた」「オレオレ設定だけど意外と人に使われてるよ」「みんなこうやってるけど自分はこんなパターンで試した」など、その人、その企業ごとで独自性をもったものになり得ると思います

yamanoku.hatenablog.com

この辺は宣伝にもなりそうなんでQiitaなり諸般の場所で書くのは程度問題にはなりますが、個人ブログや企業ブログに書いてみるというのもありかもしれません。それが結果として興味を持ってもらえる材料にもなるので

ゆるく書く意識

最後に一番重視していることとして、ゆるくやるということを忘れないようにしています

こんなに気をつけておいてゆるくって何でやねんってのはあると感じるかもですが、その辺と力みすぎてしまうのは別物だと思います

対人が見るものだから粗相のない文章を、と力むよりも、見た人がなるほどなとか、わかるわ〜と共感してくれるような語りかけ調で見てくれるのがいいよねと感じてます

あとは勢いにまかせて一気にやると良いです

 

そんなわけで自分が記事を書く時に意識していることたちでした。大したものを書いているわけではないですが、みんなでゆるく知見を広げていこうぜよ。

こちらからは以上です。

 

合わせて読みたい

yamanoku.hatenablog.com