SHIHA DOCUMENTATIONは、SHIHA PROJECTで「現在どの資料が正しいか」「どの規格を共通条件として使うか」「旧版と現行版をどう区別するか」を判断するための資料ハブです。
最初にCURRENTを確認し、次に共通規格、個別設計、変更理由の順で読む。
構想図、旧Revision、開発記録、公開画像だけを根拠に現行仕様を確定しません。
DOCUMENTATIONの役割
- 現在有効な仕様・設計正本を特定する。
- 複数ComponentにまたがるDatum、Interface、安全・Security条件を確認する。
- 設計図、構造図、試作資料を現行仕様と照合する。
- Revisionの置換関係を追跡し、旧仕様の誤使用を防ぐ。
- 未確定事項をCONCEPTまたはPROTOTYPEのまま保持し、確定事項と混在させない。
資料を読む基本順序
- CURRENT SPECIFICATIONSで、対象Componentの現行正本を特定する。
- STANDARDS & INTERFACESで、共通Datum、機械接続、電源、通信、AIR、安全条件を確認する。
- DESIGN DOCUMENTSで、図面、構造、配置、試作比較を確認する。
- SAFETY & SECURITYで、Body SafetyとCORE Securityの横断条件を確認する。
- REVISION HISTORYで、旧版から現行版への置換と互換性を確認する。
- 判断理由や試験結果が必要な場合は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と優先順位
- 対象ComponentのCURRENT仕様・設計正本
- 横断するCURRENT規格・Interface・Safety / Security方針
- 正本から参照されるCURRENT設計資料
- DEVLOGに残された決定理由・試験・変更記録
- 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 | 出来事、節目、意味、プロジェクト史 | 技術仕様ではなく物語と時間軸を確認する |
資料を更新するとき
- 変更対象、適用範囲、根拠、影響するComponentを特定する。
- 現行正本を直接上書きして履歴を失わず、Revisionと置換関係を登録する。
- 共通Interface、安全、Security、URL、CPT、SEO、Media Metadataへの影響を確認する。
- 変更理由、検討、試験結果をDEVLOGへ残す。
- CURRENT SPECIFICATIONS、関連索引、相互Linkを更新する。
主要DOCUMENTATION
公開資料と公式素材