Skip to content

inhandnet/model-reference

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

1 Commit
 
 
 
 

Repository files navigation

model-reference

映翰通设备型号专属参考文档库,主要供 AI agent 拉取作为上下文。

下游包括 incloud-skills 等 Claude Code 插件、设备本地 agent 工具。各产品线小组维护各自型号目录。

目录结构

model-reference/
├── README.md
├── index.md              # agent 入口
├── common/               # 跨型号通用内容(可选)
└── <model>/              # 型号目录(大写名,如 ER805)
    ├── index.md          # 型号入口(必须)
    └── ...               # 具体文档由本型号自定

不同型号形态差异大,型号目录内的文件命名、字段格式、子目录结构由该型号自定,在型号 index.md 中声明

Agent 阅读约定

跨型号统一:

  1. 两层 index.md(仓库根 + 型号),agent 沿这条链路定位
  2. 每份文档首段一句话说明"适用问题"
  3. 二级标题(##)即独立主题,敲定后不随意改(保持 deep link 稳定)
  4. 不用截图,状态/界面用文字描述
  5. 代码块标注语言
  6. 跨文件相对路径
  7. 中文为主,术语保留英文

型号内自定的事项(文件命名、字段格式、子目录)由型号 index.md 声明。

维护

  • 各产品线小组维护对应型号目录
  • 改动走 PR
  • 重大调整(字段重命名、目录结构)先开 issue

版权

© InHand Networks. All rights reserved.

About

Reference docs for InHand device models

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors