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

👋 ようこそ

圚溪維基ぞようこそ —— yunzaixi-dev が個人で維持管理しおいるオンラむンドキュメントサむトです。

ドキュメント分類に぀いお​

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

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

履歎専区​

  • 範囲: 本サむトの歎史、技術実装、開発ログ、サむト管理者関連情報などを蚘録したす。
  • 陀倖: 具䜓的な技術コンテンツたたは孊習ノヌト技術ドメむンで分類、プラむベヌトたたは未公開資料プラむベヌト専区ぞ、孊術コヌスコンテンツ倧孊専区ぞ。

フロント゚ンド専区​

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

バック゚ンド専区​

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

DevOps専区​

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

むンフラストラクチャ専区​

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

ワヌクフロヌ専区​

  • 範囲: 個人/チヌム効率ツヌルずプロセス、自動化スクリプト、時間管理、ノヌト/ナレッゞ管理方法、具䜓的な技術実装から切り離された䜜業習慣。
  • 陀倖: 技術実装を䞻ずするコンテンツ察応する技術分類ぞ、孊術コヌス倧孊専区ぞ。

倧孊専区​

  • 範囲: コヌスノヌト、実隓レポヌト、孊術読曞、詊隓埩習、キャンパス内プロゞェクト。
  • 陀倖: ゚ンタヌプラむズプロゞェクトたたは本番環境関連コンテンツ技術ドメむンで分類、プラむベヌト情報を含む資料プラむベヌト専区ぞ。

パブリック専区​

  • 範囲: 機密情報がなく、分野暪断的な汎甚知識、公開講挔/読曞抜粋、具䜓的な技術コンテキストなしでも理解できるコンテンツ。

  • 陀倖: 未公開情報を含むたたはアクセス制埡が必芁な資料プラむベヌト専区ぞ、技術実装の詳现技術ドメむンで分類。

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

  • 泚意: トピックが他の分類にも該圓する堎合でも、最終的な垰属はプラむベヌト専区ずなりたす。

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

LaTeX に぀いお​

1766040534079.webp

LaTeX は TeX に基づくドキュメント組版゜フトりェアシステムです。LaTeX は高床で説明的なマヌクアップ蚀語を提䟛し、TeX の䜿甚をより䟿利にしたすTeX はドキュメントレむアりトを担圓し、LaTeX はドキュメントコンテンツの凊理を担圓したす。TeX のフォヌマットコマンドは非垞に基本的であるため、著者向けに章タむトル、脚泚、盞互参照、参考文献などのフォヌマットずレむアりト芁件を満たすための既成コマンドを提䟛したす。

ドキュメントサむトの数匏衚珟に LaTeX を䜿甚しおいたす

Markdown に぀いお​

1766040842375.webp

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

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

ドキュメントサむトのコンテンツ構築に Markdown を䜿甚しおいたす

バヌゞョン管理ず CI/CD​

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 モデルを採甚し、ネットワヌクサヌビスずコマンドラむンツヌルの構築に䞀般的に䜿甚されたす。このプロゞェクトは最初 Ryan Dahl によっお 2009 幎にリリヌスされ、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 は珟代的なフロント゚ンド開発向けのビルドツヌルず開発サヌバヌで、Evan You によっお 2020 幎にリリヌスされたした。開発モヌドはネむティブ ESM のオンデマンド読み蟌みに基づき、本番ビルド段階では通垞 Rollup を䜿甚しおバンドルし、より高速な起動ずホットアップデヌト䜓隓を実珟したす。

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

Rspack に぀いお​

image.webp

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

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

Docusaurus に぀いお​

image.webp

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

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

開発原則​

自動化は手䜜業に勝る。
宣蚀的は呜什的に勝る。
䞍倉性は可倉性に勝る。
匟性は固定容量に勝る。
可芳枬性は極めお重芁である。
倱敗は䟋倖ではなく垞態である。
迅速な埩旧は倱敗の回避に勝る。
分散は単䞀䟝存に勝る。
暙準はカスタマむズに勝る。
プラットフォヌム機胜は個人技術に勝る。
むンフラストラクチャはコヌドのように管理されるべきである。
環境は䞀貫性があるべきで、たたたた動䜜するべきではない。
サヌビスは独立すべきで、盞互に絡み合うべきではない。
スケヌリングは氎平であるべきで、垂盎ではない。
リリヌスは頻繁で、ロヌルバック可胜であるべきである。
セキュリティは組み蟌たれるべきで、事埌察応ではない。