技術書の執筆を支える技術 - CADDi Tech Blog

IDチームの小森です。 CADDi プロダクトチーム Advent Calendar 2024の18日目の記事になります。 いよいよ年の瀬ですが、皆さんは年初に立てた目標などを達成できましたでしょうか。 私はずぼらなので年初の目標など立てたことはないのですが、今年ようやく5年越しの取り組みに一区切りをつけ、誓いを果たすことができました。 私事ですが、人生3冊目の著書『[改訂新版] プロになるためのWeb技術入門』を2024年11月28日に刊行しました。 おかげさまで好評をいただいております。 本エントリーでは、技術書執筆の技術的な側面について、私が取り組んできたことを紹介したいと思います。 技術書執筆に用いるマークアップ言語 大規模技術文書に必要な要件 Antoraの採用 Antoraによる執筆 Antoraによる出力の実際 複数バージョンドキュメントの生成 Antoraによるサイトジェネ

[ikajigoku]

ドキュメント書きで参考にしたい。AsciiDocとAntora。

[t_f_m]

"本執筆では、Asciidocで書いた原稿をGitリポジトリ上で管理し、CIによって自動でAntoraでHTML化しつつ、編集の方や査読者にみてもらうものはGit上に打ったTag毎のバージョンで公開するのに活用しました"

[daaaaaai]

小森さん、CADDiにいらっしゃるのか。

[lanius]

AsciiDocとAntora。

[kmaebashi]

私は過去7回本を書いて、５冊目まではLinux上でLaTeX、後の２冊はHTMLを手打ちしました(HTMLはレビューしていただくのにも便利)。また本を書く機会があれば参考にさせていただきます。

[sezemi]

AsciiDoc / Antora よさそう

[yarumato]

“技術書執筆に用いるマークアップ言語、今回はAsciiDoc（Markdownにはない機能：見出し・図表の自動ナンバリング、相互参照、ソースコードのinclude）とAntora（静的サイトを構築）を採用。AsciiDocの反省点”

[misshiki]

“AsciiDocとAntoraを中心に、大規模技術書の執筆時の工夫ポイントを紹介”