summaryrefslogtreecommitdiff
path: root/.github/instructions/documentation.instructions.md
diff options
context:
space:
mode:
Diffstat (limited to '.github/instructions/documentation.instructions.md')
-rw-r--r--.github/instructions/documentation.instructions.md15
1 files changed, 15 insertions, 0 deletions
diff --git a/.github/instructions/documentation.instructions.md b/.github/instructions/documentation.instructions.md
new file mode 100644
index 0000000..9203f57
--- /dev/null
+++ b/.github/instructions/documentation.instructions.md
@@ -0,0 +1,15 @@
+---
+applyTo: "doc/**/*.md,README.md,config.example.toml"
+---
+
+# Documentation and configuration instructions
+
+- 文書と実装を一致させる。要件は`doc/Specifications.md`、責務と処理方式は`doc/Design.md`、
+ TOML仕様は`doc/config.md`、MCP公開契約は`doc/mcp.md`へ記載する。
+- 設定キー、既定値、enum、CLI、Tool schemaを変更した場合は、すべての表とコード例を検索して同期する。
+- `config.example.toml`はコピーして編集できる有効な例に保つ。ただし実モデル名、秘密情報、利用者固有の
+ 絶対パスを追加しない。
+- MCPに公開しない設定を`doc/mcp.md`のTool入力へ追加しない。
+- 推奨値とシステムが自動適用する値を混同しない。特にLCMのstep数とCFGは推奨例に留める。
+- 日本語で簡潔かつ具体的に書き、コード上の識別子、コマンド、設定値はバッククォートで囲む。
+- 実行確認していない機能を動作済みと記載しない。