はじめに
Star Impression、カッコよすぎる... nikkieです。
タイトルが全て、ワークショップをしました🙌
目次
小さなテクニカルプラクティスのワークショップ
プロポーザルに込めた想いはこちら
資料類
テキスト
GitHub Codespaces(またはPython環境構築)案内
こぢんまりとやりました
弊社オフィスを使った現地ワークショップ(全5つ)の1つでした。
私のワークショップは4人にも来ていただき、机1卓を囲んでやりました。
1つのPCを皆で見られるこぢんまり感で、環境構築という難所は乗り越えやすかったです
- nikkieの方でワークショップ用Codespaceを立てる
- 講義形式ではあるものの、各自考えていただく時間を設ける
- 小さいTDDや小さいリファクタリングの裏にあるのは、Greenの時間が長いということではないかと思います🟩
- 「動作する、きれいなコード」のうち「動作する」を爆速で満たす
- 仮にRedにしてしまったとしても、その小さい操作をUndoすればすぐにGreenに戻れる
- Greenにしたあとは徹底的に「きれいな」にこだわる
- 動作しているわけだから、きれいにする道半ばで仮に取り上げられるとしても(心理的にしこりは残りますが)全然可能ですよね
Sphinxで資料作成、今回試した拡張
今回のテキストはSphinxでHTMLをビルドし、GitHub Pagesでホストしています。
フォントの工夫はこちら
ほかの工夫として、2つのSphinx拡張をお試ししました。
どちらも簡単に使えて大変助かりました。
- sphinxcontrib-mermaid
- https://github.com/mgaitan/sphinxcontrib-mermaid
- リファクタリング対象のコードの理解に役立てばとMermaidを使ってシーケンス図を書きました
- sphinxext-opengraph
- https://github.com/wpilibsuite/sphinxext-opengraph
- テキストの資料のページが増えたので、OGPを設定するために採用しました1
終わりに
XP祭り2023でのワークショップの開催報告でした。
小さいTDDや小さいリファクタリングという驚きを、ツール(Sphinxまわり)にもこだわって作ったテキストとワークショップでのデモを通して、ちょっとでも伝えられたんじゃないかと思います。
小さいは、正義🙌
ご参加いただいた方々、誠にありがとうございました。
皆さんで作り上げたワークショップだったと思います👏
また、当日運営いただいた実行委員の皆さまにも感謝申し上げます。
- 全ページでmetaディレクティブを使うのは大変ですからね ↩