メインコンテンツまでスキップ

PDR

PDRはPublisher's Decision Recordの略で、これまでコミュニティがどんな意思決定をしたかを記録したものです。

プロジェクトに後から参加した人にとって、本プロジェクトの方針や執筆に使うツール、文体、技術スタックなどが「どうしてそれが選ばれたのか?」「どのような経緯でそうなったのか?」といったことがわかりにくくなります。

PDRはそのような「なぜ」への答えになるよう、決定したことだけでなく、背景と理由、そして検討した代替手段などについて書きます。

採用

📄️ 0000-なぜ私たちは技術書を書くのか?

- ステータス: 採用

📄️ 0002-イテレーティブな執筆プロセス

- ステータス: 採用

📄️ 0003-読者層

本書はどのような読者層を想定するか?

📄️ 0004-各ページのステータス管理方法

各ページのステータス管理方法について

📄️ 0005-ライセンスについて

本書の利用者、及び執筆者のライセンスについて

📄️ 0006-語末には「です」「ます」(敬体)に統一する

- ステータス: 採用

📄️ 0007-関数定義のサンプルコードには極力functionを使う

- ステータス: 採用

📄️ 0008-サンプルコードではInterfaceよりType Aliasを優先して使う

- ステータス: 採用

📄️ 0009-Docusaurusを採用する

- ステータス: 採用

廃止

📄️ 0001-GitBookで執筆する

このPDRは廃止されました。代わって次のPDRを採用します。

テンプレート

PDRを追加する際は、PDRのテンプレートをお使いください。

  • 質問する ─ 読んでも分からなかったこと、TypeScriptで分からないこと、お気軽にGitHubまで🙂
  • 問題を報告する ─ 文章やサンプルコードなどの誤植はお知らせください。