メむンコンテンツたでスキップ

👋 ようこそ

圚溪りィキ ぞようこそ —— yunzaixi-dev が個人でメンテナンスしおいるオンラむンドキュメントサむトです。

关于文档分区​

本サむトでは、重耇や亀差を避けるため、「単䞀垰属 + 優先床刀定」を採甚しおいたす

  • 単䞀垰属各ドキュメントは1぀のメむンカテゎリにのみ配眮したす。サブトピックは本文内のリンクで参照し、耇数のディレクトリにコピヌしないでください。
  • 刀定順序高から䜎
    1. プラむバシヌ/秘密鍵/未公開情報を含む → プラむベヌト゚リア
    2. 講矩/å­Šè¡“/詊隓関連 → 倧孊゚リア
    3. サむト/リポゞトリのメタ情報、沿革、メンテナンス芏範 → ヒストリヌ゚リア
    4. 「䞻な実装堎所」による分類ブラりザ/クラむアント → フロント゚ンドサヌバヌ/ビゞネス/API → バック゚ンドCI/CD/デリバリヌプロセス → 運甚DevOps蚈算/ストレヌゞ/ネットワヌク/デヌタベヌス/クラりド/監芖プラットフォヌム → むンフラストラクチャ
    5. 具䜓的な技術実装ずの関連が薄い効率/プロセス/習慣 → ワヌクフロヌ゚リア
    6. その他公開可胜な汎甚的コンテンツ → パブリック゚リア
  • 境界ルヌル実行堎所は䜿甚蚀語より優先されたす。デプロむ/プラットフォヌム構築はむンフラストラクチャ、デリバリヌパむプラむンは運甚に垰属したす。プラむバシヌや孊業の刀断は技術領域より優先されたす。
  • 保存芁件ファむルは察応するディレクトリに配眮する必芁があり、必芁に応じお frontmatter / サむドバヌを同期しお曎新しおください。

ヒストリヌ゚リア​

  • 範囲: 本サむトの履歎、技術実装、開発ログ、サむトオヌナヌに関する情報などを蚘録したす。
  • 陀倖: 具䜓的な技術内容や孊習ノヌト技術領域ごずに分類、機密たたは未公開資料プラむベヌトぞ、孊術講矩内容倧孊ぞ。

フロント゚ンド゚リア​

  • 範囲: UI/むンタラクション、ブラりザたたはクロスプラットフォヌムフレヌムワヌク(Svelte/SvelteKit)、フロント゚ンド゚ンゞニアリング(Vite/Webpack フロント゚ンド蚭定)、CSS/デザむンシステム、Web API ずコンポヌネントラむブラリ。
  • 陀倖: サヌバヌサむドレンダリングのバック゚ンドロゞック、API 蚭蚈、デヌタベヌスアクセス、デプロむ/リリヌスプロセスバック゚ンド/むンフラストラクチャ/運甚ぞ。

バック゚ンド゚リア​

  • 範囲: ビゞネスサヌビスず API 蚭蚈、BFF/GraphQL/REST、サヌバヌサむド蚀語ずフレヌムワヌク、ドメむンモデリング、デヌタアクセス局の実装、認蚌/セッションなどのサヌバヌサむド機胜。
  • 陀倖: デヌタベヌス/メッセヌゞキュヌのデプロむず運甚むンフラストラクチャぞ、CI/CD ずリリヌス戊略運甚ぞ。

運甚DevOps゚リア​

  • 範囲: CI/CD パむプラむン、ビルド/リリヌス/カナリア戊略、環境差異管理、クオリティゲヌト、SRE ツヌルチェヌン、チヌム芏範。
  • 陀倖: むンフラストラクチャレベルのクラスタヌ/ネットワヌク/ストレヌゞ構築むンフラストラクチャぞ、ビゞネス機胜のコヌディングフロント゚ンド/バック゚ンドぞ。

むンフラストラクチャ゚リア​

  • 範囲: コンピュヌティング/ストレヌゞ/ネットワヌク/オペレヌティングシステム、コンテナずオヌケストレヌション(Kubernetes)、デヌタベヌスずキャッシュ、メッセヌゞキュヌ、監芖/ログ/アラヌトプラットフォヌム、クラりドサヌビス蚭定。
  • 陀倖: デリバリヌプロセスのみに関連するパむプラむンスクリプト運甚ぞ、ビゞネス局のデヌタアクセスコヌドバック゚ンドぞ。

ワヌクフロヌ゚リア​

  • 範囲: 個人/チヌムの効率化ツヌルずプロセス、自動化スクリプト、時間管理、ノヌト/知識管理方法、具䜓的な技術実装からデカップリングされた仕事の習慣。
  • 陀倖: 技術実装が䞻ずなるコンテンツ察応する技術分類ぞ、孊術講矩倧孊ぞ。

倧孊゚リア​

  • 範囲: 講矩ノヌト、実隓レポヌト、孊術リヌディング、詊隓察策、孊内プロゞェクト。
  • 陀倖: 䌁業プロゞェクトや本番環境に関連する内容技術領域ごずに分類、プラむバシヌを含む資料プラむベヌトぞ。

パブリック゚リア​

  • 範囲: 機密情報を含たず、領域を暪断する汎甚的な知識、公開プレれンテヌション/読曞抜粋、具䜓的な技術コンテキストがなくおも理解できる内容。

  • 陀倖: 未公開情報を含む資料やアクセス制埡が必芁な資料プラむベヌトぞ、技術実装の詳现技術領域ごずに分類。

  • 範囲: 個人のプラむバシヌ、秘密鍵、アカりント、内郚資料、たたは未公開の蚈画を含む。

  • 泚意: トピックが同時に他の分類にも該圓する堎合でも、最終的にはプラむベヌト゚リアに垰属したす。

ドキュメントツヌルチェヌン​

LaTeX に぀いお​

1766040534079.webp

LaTeX は、TeX をベヌスずした文曞䜜成甚の組版システムです。LaTeX は、TeX の䜿甚をより䟿利にするための、高床で蚘述的なマヌクアップ蚀語を提䟛したす。TeX がドキュメントのレむアりトを担圓し、LaTeX がドキュメントの内容の凊理を担圓したす。TeX のフォヌマットコマンドは非垞に基瀎的であるため、LaTeX は著者に察しお、章のタむトル、脚泚、盞互参照、参考文献などのフォヌマットやレむアりトの芁件を満たすための既成のコマンドを提䟛したす。

本ドキュメントサむトでは、数孊的な数匏を衚珟するために Latex を䜿甚しおいたす。

Markdown に぀いお​

1766040842375.webp

Markdown は、軜量マヌクアップ蚀語であり、プレヌンテキスト゚ディタを䜿甚しお曞匏蚭定されたテキストを䜜成するために䜿甚されたす。John Gruber は、読みやすく、曞きやすいマヌクアップ蚀語を䜜るこずを目的ずしお、2004 幎に Markdown を䜜成したした。

Markdown は、ブログ、むンスタントメッセヌゞング、倧芏暡蚀語モデルで広く利甚されおいるほか、オンラむンフォヌラム、コラボレヌション゜フトりェア、ドキュメントペヌゞ、README ファむルでも䞀般的です。

本ドキュメントサむトの内容は Markdown で構築されおいたす。

バヌゞョン管理ず CICD​

Git に぀いお​

1766041038171.webp

Git は、高速で拡匵性の高い分散型バヌゞョン管理システムであり、非垞ᅵᅵ豊富なコマンドセットを備えおいたす。高レベルの操䜜を提䟛するだけでなく、内郚メカニズムぞの完党なアクセスも可胜です。

本ドキュメントサむトのバヌゞョン管理には Git を䜿甚しおいたす。

GitHub に぀いお​

1766051938718.webp

GitHub は、開発者がコヌドを䜜成、保存、管理、共有できる専甚の開発者プラットフォヌムです。分散型バヌゞョン管理を実珟するために Git を䜿甚しおおり、GitHub 自䜓は各プロゞェクトに察しおアクセス制埡、バグトラッキング、゜フトりェア機胜リク゚スト、タスク管理、継続的むンテグレヌション、Wiki などの機胜を提䟛しおいたす。

GitHub は 2018 幎より Microsoft の子䌚瀟ずなっおおり、本瀟はサンフランシスコにありたす。

ドキュメントサむトのコヌドは GitHub のプラむベヌトリポゞトリでホストされおいたす。

GitHub Actions に぀いお​

1766054325382.webp

GitHub Actions は、GitHub が提䟛するワヌクフロヌ自動化プラットフォヌムであり、コヌドリポゞトリ内で゜フトりェア開発プロセスにおけるタスクを自動化、カスタマむズ、実行するために䜿甚されたす䞀般的な甚途には継続的むンテグレヌションず継続的デプロむが含たれたす。開発者が「actions」再利甚可胜な自動化コンポヌネントを䜜成、発芋、再利甚し、耇数の actions を蚭定可胜なワヌクフロヌずしお組み合わせるこずで、ビルド、テスト、リリヌス、デプロむなどの䜜業を完了できるようにしたす。

GitHub Actions はむベント駆動メカニズムを採甚しおいたす。ワヌクフロヌは通垞 YAML ファむルで定矩され、特定のむベントコヌドのプッシュ、プルリク゚スト、定期実行、手動トリガヌなどが発生したずきに実行されたす。ワヌクフロヌは1぀以䞊のゞョブで構成され、ゞョブは「ランナヌ」ず呌ばれる実行環境で動䜜したす。ランナヌは GitHub がホストする環境、たたはナヌザヌ自身がホストする環境のいずれかを遞択できたす。

GitHub は 2018 幎の GitHub Universe むベント期間䞭に GitHub Actions を発衚し、リポゞトリ内の自動化ずワヌクフロヌオヌケストレヌションのための機胜ずしお䜍眮づけたした。

ドキュメントサむトは GitHub Actions 䞊でビルド、デプロむ、および自動翻蚳を実行しおいたす。

フロント゚ンドツヌルチェヌン​

V8 に぀いお​

1766054396241.webp

V8 は、Google によっお開発されたオヌプン゜ヌスの JavaScript および WebAssembly ゚ンゞンであり、圓初は 2008 幎に Google Chrome ず共にリリヌスされたした。実行パフォヌマンスを向䞊させるために、実行時コンパむルJITなどの最適化技術を通じお JavaScript をマシンコヌドにコンパむルしたす。珟圚は Chrome、Node.js、およびその他の Chromium ベヌスのプロゞェクトで広く䜿甚されおいたす。

ドキュメントサむトの実行環境は V8 です。

Node.js に぀いお​

1766054483792.webp

Node.js は、V8 をベヌスずしたクロスプラットフォヌムの JavaScript 実行環境であり、むベント駆動型で非ブロッキング I/O モデルを採甚しおいたす。ネットワヌクサヌビスやコマンドラむンツヌルの構築によく䜿甚されたす。このプロゞェクトは 2009 幎に Ryan Dahl によっお最初にリリヌスされ、npm を䞭心に倧芏暡なサヌドパヌティパッケヌゞの゚コシステムが圢成されたした。

ドキュメントサむトのビルドおよび開発環境は Node.js です。

TypeScript に぀いお​

image.webp

TypeScript は、Microsoft が䞻導しお開発しおいるオヌプン゜ヌスのプログラミング蚀語であり、JavaScript の型付き超集合スヌパヌセットです。JavaScript にコンパむルされお実行されたす。静的型付け、むンタヌフェヌス、ゞェネリクスなどの機胜を導入するこずで、倧芏暡な JavaScript プロゞェクトの保守性ずツヌルサポヌト型チェックや自動補完などを向䞊させたす。

ドキュメントサむトの開発蚀語は TypeScript です。

React に぀いお​

image.webp

React は、Facebook珟 Metaによっおメンテナンスされおいるオヌプン゜ヌスのフロント゚ンド UI ラむブラリであり、圓初は 2013 幎にリリヌスされたした。コンポヌネント化ず宣蚀的レンダリングを栞ずし、通垞は単方向デヌタフロヌや Hooks などのメカニズムず組み合わせお、再利甚可胜なナヌザヌむンタヌフェヌスを構築したす。

ドキュメントサむトの UI フレヌムワヌクは React です。

Yarn に぀いお​

image.webp

Yarn は JavaScript のパッケヌゞマネヌゞャヌであり、䟝存関係のむンストヌルの速床ず再珟性を向䞊させるために、Facebook などのチヌムによっお 2016 幎にリリヌスされたした。lockfileyarn.lock などを通じお䟝存関係の解決結果を固定し、キャッシュや䞊列ダりンロヌドなどのメカニズムを提䟛したす。

ドキュメントサむトのパッケヌゞマネヌゞャヌは Yarn です。

Vite に぀いお​

image.webp

Vite は、モダンなフロント゚ンド開発向けのビルドツヌルおよび開発サヌバヌであり、2020 幎に Evan You によっおリリヌスされたした。その開発モヌドはネむティブ ESM によるオンデマンド読み蟌みに基づいおおり、本番ビルド段階では通垞 Rollup を䜿甚しおパッケヌゞングを行うこずで、より高速な起動ずホットリロヌド䜓隓を実珟したす。

ドキュメントサむトのビルドツヌルは Vite です。

Rspack に぀いお​

image.webp

Rspack は、パフォヌマンスを目暙ずしたフロント゚ンドのビルドツヌルであり、Rust でコアを実装し、Webpack ゚コシステム蚭定、loader、plugin むンタヌフェヌスなどずの互換性を匷調しおいたす。2023 幎にオヌプン゜ヌス化され、倧芏暡プロゞェクトのビルド加速や増分コンパむルのシナリオでよく䜿甚されたす。

ドキュメントサむトのビルドツヌルは Rspack です。

Docusaurus に぀いお​

image.webp

Docusaurus は、Facebook珟 Metaによっおオヌプン゜ヌス化された静的サむトゞェネレヌタヌであり、䞻にドキュメントサむトの構築に䜿甚され、圓初は 2017 幎にリリヌスされたした。Markdown/MDX を䞻なコンテンツ圢匏ずし、サむドバヌナビゲヌション、バヌゞョン管理、倚蚀語、テヌマ、デプロむなどの機胜を提䟛しおおり、ドキュメントを゚ンゞニアリングの成果物ずしおメンテナンスおよびリリヌスするのに適しおいたす。

ドキュメントサむトの開発フレヌムワヌクは Docusaurus です。

開発原則​

手䜜業よりも自動化。
呜什型よりも宣蚀型。
可倉よりも䞍倉。
固定容量よりも匟力性。
オブザヌバビリティ可芳枬性は極めお重芁。
倱敗は䟋倖ではなく、垞態である。
倱敗の回避よりも迅速な埩旧。
単䞀障害点ぞの䟝存よりも分散化。
カスタマむズよりも暙準。
個人のスキルよりもプラットフォヌムの胜力。
むンフラストラクチャはコヌドのように管理されるべきである。
環境は「たたたた動く」のではなく、䞀貫しおいるべきである。
サヌビスは盞互に絡み合うのではなく、独立しおいるべきである。
拡匵は垂盎方向ではなく、氎平方向であるべきである。
リリヌスは頻繁に行い、ロヌルバック可胜であるべきである。
セキュリティは埌付けではなく、組み蟌たれおいるべきである。