文芸的diffでソースコードを解説する - ABAの日誌

プログラムの解説文章をソースコードに混在して表記し、そこから解説記事を生成する、文芸的プログラミングという手法がある。 文芸的プログラミングはソースコードに強く結びついた形でドキュメントを管理することができ、ソースコードの解説を記述するためには良い手法である。ただし、生成される解説記事はあくまでソースコードの記述順に沿ったものであり、プログラマの開発手順、実装順序に沿ったものでは無い。 ソースコードの解説は、そのコードが作られた順番に行われたほうが、プログラマの思考に沿って説明がされるので分かりやすい。そのような発想に基づいて提案された手法が、文芸的コミットだ。 コミットメッセージに、そのコミット内容を説明する文章を記述していくことで、コミットのヒストリーが解説記事になる手法だ。この方式だと、コミットというコードが改変されていく順番で解説ができるので、より分かりやすい内容にできる。 この方

[ABA]

ミニゲームの作り方を、解説・ソースコード・ゲーム画面の3つを並行して見られる、文芸的diffという手法はどうでしょうという記事を書いた

[mojimojikun]

スゲェ。わかりやすく面白い。https://abagames.github.io/literate-diff-viewer/pinclimb/index.html?lang=ja

[daichirata]

コミットに沿った解説の記事を github のコミットログを貼り付けて書いたことがあるけど、diff までは絶対読まれてないだろうなという感じがあったのでこれは良さそう。

[masa8aurum]

これはわかりやすい / README.md 内の各所からソースコードのファイル名を指定する模様

[yarumato]

“文芸的プログラミングとは解説文章をコードに記述する手法だが開発順序に沿わない。文芸的コミットは、コード作る順番で解説されるが作成面倒。文芸的diffという手法を考えた。解説に対応するdiffで手順を確認”

[cocoasynn]

ドキュメンテーションの改善について考える機会が多いのでとても興味深かった。

[mizdra]

面白い

[efcl]

git diffから解説文を生成する仕組み

[xlc]

ドキュメントは開発が終わってからゆっくり書きたいなあ。

[koba789]

すごい。ファイル間で履歴を rebase できるようになるとさらに便利そう！

[naari_3]

前ホッテントリに上がってたReactを自作するチュートリアル記事もこんな感じだったよね、かなりかっこいい

[tmatsuu]

とてもいいね。Jupyter Notebookと相性がよさそうなので良い感じに組み合わせられないだろうか。

[namuts]

すげ

[dalmacija]

すてき

[kagehiens]

ステキな読み物。ナラティブなDiffですね。

[yasushicohi]

文芸的diff

[kamocyc]

チュートリアルで簡単なdiffを載せてるのあるけど、自動化したら確かによさそう

[circled]

真っ暗なバグのトンネルを抜けると、そこは完全に頭真っ白な雪景色でした。(違

[hase0510]

「文芸的」というワードで閃いたけど、GitHubのIssue、PR、Discussionを#番号順に見ていくとドラマになってるようにしたら面白くない？ GitHub文学。ミステリー要素も入れてみたりして。誰かやってみて。

[at_yasu]

何故か 乙女文藝ハッカソン を思い出した