Vize

ノートレーン

リファレンス ドキュメントは、「これをどのように使用するか?」という質問に答えるのに優れています。彼らは次のような質問に答えるのがはるかに下手です。

  • なぜこの機能が追加されたのですか?
  • このアーキテクチャはどのようなトレードオフによって導かれたのでしょうか?
  • 有望だがまだ安定していない実験はどれですか?
  • プロジェクトは次に何を学ぼうとしていますか?

そのため、ドキュメントには別のメモレーンが含まれるようになりました。

ここに属するもの

メモは意図的に不規則です。投稿には次のようなものがあります。

  • 1週間のコンパイラ作業後の開発ブログ
  • 新しいクレートのアーキテクチャに関する記述
  • Musea、LSP、または Vite 統合に関する設計メモ
  • 便利ですが、バージョン タグに関連付けられていない短いプロジェクトの更新

すべてをリリースノートに記載しない理由

リリース ノートは出荷時の変更に合わせて最適化されています。それらは明確で実行可能なものである必要があります。

メモには、機能の背後にあるコンテキスト、ロードマップの形状、読者が長期的にプロジェクトを理解するのに役立つ考え方など、より広範なストーリーテリングのための余地が生まれます。

書き込み方向

疑問がある場合:

  • 投稿で出荷されたものを発表する場合はリリース ノートを使用してください
  • 投稿で思考、進捗状況、実験について説明している場合はメモを使用してください