DOCUMENTATION HUB

SHIHA DOCUMENTATION

現在仕様、規格、設計資料、改訂履歴、安全方針を探すための技術文書ハブです。

SHIHA DOCUMENTATIONは、SHIHA PROJECTで「現在どの資料が正しいか」「どの規格を共通条件として使うか」「旧版と現行版をどう区別するか」を判断するための資料ハブです。

最初にCURRENTを確認し、次に共通規格、個別設計、変更理由の順で読む。

構想図、旧Revision、開発記録、公開画像だけを根拠に現行仕様を確定しません。

DOCUMENTATIONの役割

資料を読む基本順序

  1. CURRENT SPECIFICATIONSで、対象Componentの現行正本を特定する。
  2. STANDARDS & INTERFACESで、共通Datum、機械接続、電源、通信、AIR、安全条件を確認する。
  3. DESIGN DOCUMENTSで、図面、構造、配置、試作比較を確認する。
  4. SAFETY & SECURITYで、Body SafetyとCORE Securityの横断条件を確認する。
  5. REVISION HISTORYで、旧版から現行版への置換と互換性を確認する。
  6. 判断理由や試験結果が必要な場合はDEVLOG、出来事の意味や節目はCHRONICLEを参照する。

主要索引

索引答える問い含めるもの
CURRENT SPECIFICATIONS現在、何が正しいかCURRENT判定された仕様・設計正本
STANDARDS & INTERFACES全体で共有する条件は何かDatum、機械IF、電源、通信、AIR、安全・Security方針
DESIGN DOCUMENTS形状・配置・構造はどうなっているか図面、断面、構造図、配置図、比較案、Reference Visual
SAFETY & SECURITY危険と権限をどう制御するかE-STOP、Watchdog、Limit、Safe Pose、OWNER認証、Recovery
REVISION HISTORY何が何に置き換わったかCURRENT、SUPERSEDED、ARCHIVED等の関係

資料状態の読み方

Record Status意味扱い
CURRENT現在の判断基準として有効現行正本として参照する
CONCEPT構想・理想・検討方向採用済み仕様や実装済み機能とみなさない
PROTOTYPE試作・実測・比較・調整段階正式製作へ使う前にCURRENT正本と照合する
SUPERSEDED新Revisionへ置換された旧版履歴として残し、現行設計へ戻さない
ARCHIVED終了・保存対象歴史記録として参照し、現行仕様と分離する

Development Statusは開発の進み具合、Record Statusは資料の有効性、Document Kindは文書の種類を表します。これらは別の項目であり、例えば「開発中だがCURRENTの仕様」や「完成済みだがSUPERSEDEDの旧版」が存在します。

SSOTと優先順位

  1. 対象ComponentのCURRENT仕様・設計正本
  2. 横断するCURRENT規格・Interface・Safety / Security方針
  3. 正本から参照されるCURRENT設計資料
  4. DEVLOGに残された決定理由・試験・変更記録
  5. CONCEPT、PROTOTYPE、SUPERSEDED、ARCHIVEDの参考資料

同じ名称や数値が競合する場合は、Revision番号だけで判断せず、Record Status、対象Component、適用範囲、更新日、置換関係を確認します。未確定事項は推測で補完せず、NOT SETまたは未確定として維持します。

DOCUMENTATIONとLIBRARYの違い

入口主な目的代表的な内容
DOCUMENTATION現在正しい仕様・規格・設計を判断する現行仕様、共通規格、設計資料、安全方針、改訂履歴
LIBRARY公開資料・画像・配布物を探して利用するPUBLIC IMAGE LIBRARY、MEDIA KIT、DOWNLOADS、公開Archive

PUBLIC IMAGE LIBRARYの画像やMEDIA KITの公式素材は公開利用のための資産です。仕様値を確定する正本ではありません。画像に仕様らしい表記があっても、CURRENT仕様ページで確認します。

開発記録との関係

記録役割DOCUMENTATIONとの関係
DEVELOPMENT STATUS各開発系統が現在どこまで進んでいるか仕様の有効性ではなく進捗を確認する
DEVLOG製作、試験、失敗、判断、変更理由正本がそうなった理由を追跡する
CHRONICLE出来事、節目、意味、プロジェクト史技術仕様ではなく物語と時間軸を確認する

資料を更新するとき

  1. 変更対象、適用範囲、根拠、影響するComponentを特定する。
  2. 現行正本を直接上書きして履歴を失わず、Revisionと置換関係を登録する。
  3. 共通Interface、安全、Security、URL、CPT、SEO、Media Metadataへの影響を確認する。
  4. 変更理由、検討、試験結果をDEVLOGへ残す。
  5. CURRENT SPECIFICATIONS、関連索引、相互Linkを更新する。

主要DOCUMENTATION

公開資料と公式素材