# Portability: UNIVERSAL
# Last validated: 2026-05-17
# Next review: 2027-05-17

ガイドライン - 文書化基準
=====================================

ステータス: 2026-02-08

3 レベル システム
-------------------
1。動作中 (docs/help/*.txt)
   - BACHはどうやって使うのですか？
   - 焦点: CLI コマンド、ガイド、リファレンス。
   - 形式: TXT (ASCII 互換、最大 250 行)。

2.知識 (wiki/*.txt)
   - X とは何ですか?
   - 焦点: 背景知識、ドメイン知識、AI 理論。
   - 形式: TXT (ASCII 互換)。

3.概念 (skills/**/*.md、docs/*.md)
   - なぜ、どのように構築されるのですか?
   - 焦点: アーキテクチャ、ワークフロー、より深い分析。
   - 形式: MarkDown (豊富な図解/構造化)。

メタデータ必須 (新規 2026-01)
-------------------------------
すべてのドキュメント ファイルには次のヘッダーが必要です:

  # 携帯性: ユニバーサル |システム |ユーザー
  # 最終検証日: YYYY-MM-DD
  # 次のテスト: YYYY-MM-DD
  # ソース: [オプション]

チェック間隔:
  システム: +3 か月 (コードリンク、頻繁に変更されます)
  ユニバーサル: +6 か月 (通常有効、安定)
  ユーザー: +12 か月 (ユーザー固有、長期継続)

TX/TXT 構造 (クラシック)
---------------------------
  タイトルを大文字で表記
  ========================
  [メタデータ ヘッダー]

  説明
  [この機能の機能]

  コマンド
  bach [befehl] [argumente]

  例
  [具体的な使用例]

  関連項目
  [他の docs/help/ または wiki/ ファイルへのリンク]

ライフ サイクル分析
---------------------
1。作成: ユーザー/ANALYSE_Thema.md
2. 評価: 調査結果 → docs/help/ または wiki/。タスク→タスクシステム。
3. アーカイブ: 完了後、user/_archive/ に移動します。

命名規則
------------------
docs/help/<topic>.txt 単純なトピック
docs/help/<command>.txt CLI コマンドのドキュメント
wiki/<special>.txt 外部知識

SKILL_<n>.md スキルのドキュメント
CONCEPT_<n>.md コンセプト ドキュメント
<n>_ANALYSE.md 分析レポート
<トピック>_Proposal.md 提案 (承認待ち)

品質基準
-------------------
docs/help/*.txt ファイル:
- 最大。 250 行 (150 行未満を推奨)
- マークダウン構文なし (ASCII 互換)
- すべてのコマンドを文書化
- 少なくとも 1 つの例
- 関連項目 リファレンス

関連項目
----------
user/_archive/guideline_Proposition.md 完全な概念 (アーカイブ済み)
bach --help practices                    アーキテクチャの原則
bach --help naming                       命名規則
