TSKaigi

トーク

技術書をソフトウェア開発する - jsprimerの10年から学ぶ継続的メンテナンスの技術

発表概要

技術書の執筆とソフトウェアの開発に、大きな違いはありません。
LLMを使って自然言語でコードを書ける/読めるようになった現在では、この違いはますます小さくなっています。
約10年・6つのメジャーバージョンを経ているJavaScript入門書 jsprimer を例に、技術書のソフトウェア開発手法について紹介します。

特に次の点を中心にお話しします。

  1. ドキュメントとコードの自動テスト - textlintやpower-doctestなどのTypeScriptで書かれたツールでの自動テスト
  2. ECMAScript年次更新への追従プロセス - 言語仕様の変化に合わせた計画的な更新手法
  3. ドキュメントに対するDesign Doc - 文章を書く前に文章の設計をソフトウェア開発のように行う方法
  4. コミュニティ貢献を促す仕組み - 累計で100名以上のコントリビューターが参加するjsprimerの運営方法/Open Collectiveの設計

「TypeScriptは型を消せばJavaScript」と言われるように、TypeScriptとJavaScriptには密接な関係があります。
この発表では、TypeScriptの基盤となるJavaScriptの学習リソースがどのように持続的に更新されてきたか、その技術的な工夫をお話しします。

技術書は、ソフトウェアと同様に適切な設計・開発・運用プロセスを持つことで、長期的なメンテナンスと進化が可能になることについて、約10年間の具体的な実践例を通してお伝えします。

対象者

  • TypeScript/JavaScript開発者:更新され続ける言語仕様に追従する方法について知りたい方
  • 技術書籍・ドキュメント作成者:継続的に更新される技術文書の作り方を知りたい方
  • OSSメンテナー:ドキュメント中心のプロジェクト運営、コントリビューター獲得に悩む方
azu

azu

ISO/IEC JTC 1/SC 22/ECMAScript Ad Hoc委員会 エキスパートでECMAScript、JSONの仕様に関わる。2011年にJSer.infoを立ち上げ、継続的にJavaScriptの情報を発信している。ライフワークとしてオープンソースへのコントリビューションをしている。

https://jsprimer.net/
XGitHub