kit84 talks

社会人 / AtCoder 緑 / くBC 水

くそなぞなぞ解説記事を執筆するための Tips

この記事は くそなぞなぞ Advent Calendar 2021 18 日目の記事として執筆されました。

これは何ですか?

こんばんは、 kit84 です。 先日は くVC 016 を開催いたしました。
いつもご参加くださる皆様に感謝申し上げます。

当記事では、私自身がくそなぞなぞの解説記事を執筆する際に心掛けていることを紹介します。

要は、お気持ち表明です。

tl;dr

  1. 必ず答えを書く
  2. 関連する全ての要素を説明する
  3. 参加者に対する感謝と尊敬の気持ちを忘れない

そんな私が書いた記事がこちら

kit84.hatenablog.com

あくまで一例として、ご参考まで。


解説記事の Tips

1. 必ず答えを書く

答えがあると、問題を解決できます。

したがって、「答えだけで十分」といっても過言ではありません。

「でも、直接的なネタバレを避けたい……」という場合は、HTML の要約機能 (<summary>, <details>) を用いると便利です。

こんな感じになります
ここに答えを書く

ソースコード

<details>
  <summary><b>こんな感じになります</b></summary>
  <blockquote>ここに答えを書く</blockquote>
</details>

スマホを含む一般的なブラウザ環境 (Internet Explorer を除く) で表示が崩れることはないので、どんどん使いましょう。 (参考)

2. 関連する全ての要素を説明する

前提知識は全て示しましょう。

例えば、要素 A と B が掛かった問題があったとします。解説に A だけが説明されていて、B は省略されていたとしたら、読者はどう思うでしょうか…

例題: 「出て行く動物ってなーんだ?」

よくない説明: 「猿」という動物を知っていれば容易です。

よい説明: 「出て行く」を「去る」に言い換えると、「猿」という動物に通じます。

参加者が複数いれば、「猿は知っていたけど『去る』は分からなかった…」という人もいるし、「去るだけ分かった」という人も「両方知らなかった」という人も出てきます。

作者にとって自明だからといって、説明を省略されると嫌な気持ちになります。

3. 参加者に対する感謝と尊敬の気持ちを忘れない

これは最も大事です。

コンテストに参加する人は、いつも貴重な時間を割いてくださっています。
「くそ」といえど難問に立ち向かい、時間いっぱいまで諦めず考え抜く。とても尊敬すべき姿勢だと思います。このような参加者が大勢いらっしゃるのは、とても誇らしいことです。

そんな方々にお読みいただく解説記事に、なっているでしょうか?

コンテスト終了直後は、参加者も疲れ果てていることでしょう。
そんな時に読む解説記事は、できれば短く、分かりやすいものが望ましいです。

おわりに

最後になりましたが、Shitforces 製作の店長さん!!!!
いつも本当にありがとうございます!!!!!!