[技術書典15] 記事書き上げを完走した感想 - in Code Polaris

この記事はCode Polaris Advent Calendar 2023の 5日目の記事です。

本について

女性による女性のための技術コミュニティ「Code Polaris」に参加しているメンバーで執筆した本です。
Code Polaris Tech Book vol.2：Code Polaris - 技術書典

Code Polaris¹で出版する同人誌としては、2冊目になります。

寄稿した人数は9名です(私は初参加です)。

コミュニティメンバーの事情もあり、オンラインのみの出店でした。

書いた記事について

私の書いた記事は「第2章 Unityを絵文字ジェネレーターにしてみた」になります。

Unity初心者・初学者向けに、サンプルプロジェクトの解説を行っています。

何かの足掛かりになれば幸いです。
…しかし果たして伝わっただろうか…？心配です…

執筆環境

Re:VIEW を使用しました。
TechBooster/ReVIEW-Template のフォーク環境です。

個人環境として、Visual Studio CodeでDev Conteinerを立てて書いていました。
GitHub Codespace使っても良かったのですが、別のコミュニティで Re:VIEW を使って書いたとき、
ローカルでDockerを立ち上げていた記憶があったので、
今回もそうした感じです。

完走した感想

第一稿、自分は遅刻しました…

レビュワーの負担を考えるなら、第一稿締め切り1週間前には仕上げるべき…
いや、もっと早い段階が理想ですね。すみません…。

原因としては

• 多忙で、執筆時間、サンプルプロジェクト作成時間が限られている
• Unityに触ったことがない方向けといいつつ、導入ハードルが高い
  • 一般的ではない、エディタ拡張の話が中心になっている
  • レンダーパイプラインの話を持ち込んでいる
• サンプルプロジェクトを作るのが遅かった
  辺りが考えられます。

時間の問題は、そのまま仕事の問題に直結しているのでここではあまり書きませんが…
やることがあるなら、定時に帰れるときに定時に帰って作業しようね！
(Code Polarisのほかのイベント参加含めて、NaN敗してる…)

誤字脱字、リンク切れが多かった

これはツールを活用しなかった問題もあります。
レビュワーの負担がさらに増えるから、やめようね！(5敗以上してる)

文章校正ツール、入れたい

私のZennでの執筆環境では textlint² を入れ、
Pull Requestでは reviewdog³ が動くようになっています。
Re:VIEW環境でも、自主的に入れていきたいですね。
ここは要検討です。

リンク切れ

具体的には @<href> でURLだけを記載した際、
ビルド環境によってはリンクとして認識されませんでした。

何故これが起きるかについては、
追跡するための調査は行っていないため、詳細はわかりません。

予防策として今後、Re:VIEWでリンクだけだと思っていても、
必ずテキスト部分とURL部分、両方に書きましょう。

Unity知らない人向け、にしてはまだハードルが高そう

Unityも含め、初めてのゲームエンジンというのは、環境構築自体はそう難しくないですが
覚えなければならないエンジン特有の前提知識、というのが結構多いです。

特に 短期間で空のプロジェクトからサンプルプロジェクトに近づける、
というのはほぼ不可能 です。
初心者から脱してしまうと、このことを忘れちゃいますね…。

これだったら、技術解説より
「Unity拡張は楽しいぞ！」の方向に
思いっきり舵を切ってしまったほうがよかったかな、と思ってます。

ぼくのかんがえた さいきょうの ツールづくり、たのしいぞ！

次に繋げること

来年も、コミュニティ内で機会あれば何か書こうと思っています。
あわよくばUnreal Engine版を…と思ってます。…勉強、間に合うかな…？

仮にUnreal Engineでなくても、IT系が多い中で変わらず異色の記事を書くつもりです。
だってゲーム好きなので。好きなものを仕事にしてご飯食べてますので。

Code Polarisの皆様、
これからも、来年も、宜しくお願い致します。

1. 私はゲーム業界から参戦しましたが、温かく見守っていただいております。同じ人いないかなぁ。それか誰か来てくれないかな…。 ↩

2. Node.js環境で動作する、文章校正ツール。
   textlint を中心に、様々な文章校正ルールが入れられる。
   例えば、textlint-rule-preset-japanese(日本語向け文章校正ルール) や textlint-rule-preset-ja-technical-writing(日本語向け技術文章校正ルール) などがある。 ↩

3. textlintなどのツールから出力された結果を元に、機械的にコメントをつけてくれるツール。
   GitHubのPullRequest, GitHub Actionと組み合わせるといい感じになるのでお勧め。
   https://github.com/reviewdog/reviewdog ↩