中文文档不是独立包，须与代码同仓共版本；README.md首行必为composer require命令及PHP/扩展要求；双语用二级标题分隔；docs/目录扁平化、小写短横线命名、含YAML front matter；所有内容须严格匹配composer.json约束与源码结构。
中文文档包不是单独发布的“包”，而是你已有的 Composer 包自带的文档资产，必须和代码版本严格对齐、共存于同一仓库。不存在“发布文档包”这回事，只有“如何让中文文档被正确发现、阅读、维护”。
README.md 必须放在包根目录，且第一行就是安装命令
用户打开你的 GitHub 仓库，第一眼看到的就是 README.md。它不是可选说明，而是安装入口。
- 第一行必须是
composer require vendor/package-name（带具体包名，小写、短横线分隔） - 紧跟着写明最低要求：
Requires PHP >= 8.1 and ext-json—— 不写清楚，别人一执行就报Your requirements could not be resolved - 如果包有中文特性（比如默认返回中文错误消息、支持中文配置键），在 “Features” 小节用简短 bullet 点出，例如：
Supports zh_CN locale out of the box - 别把英文 README 和中文 README 拆成两个文件。如需双语，用二级标题分隔，例如
## 使用示例 (Usage Example)后直接跟中文代码块，不加“中文版”前缀
docs/ 目录是中文文档主阵地，结构要扁平可导航
所有非入门级内容（API、进阶配置、故障排查）应放进 docs/ 目录，而非堆在 README 里。这个目录是给真正想用好你包的人准备的。
Discussion Composer
下载
围绕关键发现、作用机制、临床相关性及研究局限性展开讨论。适用于撰写或优化任何生物医学论文的“讨论（Discussion）”部分——包括结果解读、与既往文献关联、阐释意外发现、界定研究局限性，以及撰写结论。当用户输入以下任一指令时也会自动触发该功能： - “write my discussion” - “help me discuss my findings” - “how do I compare to prior studies” - “write the limitations par
- 命名全部用小写 + 短横线：
docs/01-installation.md、docs/02-configuration.md、docs/zh-api-reference.md - 避免嵌套子目录，
docs/guide/或docs/zh_CN/这类路径会让 CI 构建和本地预览变复杂 - 每个文件开头加 YAML front matter 标注语言，方便后续生成静态站时识别：
--- lang: zh-CN --- - 链接全部用相对路径：
[配置选项](02-configuration.md#timeout)，不要写成https://github.com/.../blob/main/docs/02-configuration.md
中文文档不能脱离 composer.json 的约束来写
文档里写的每一个类名、命名空间、配置键、函数参数，都必须和 composer.json 中的 autoload 和源码实际结构完全一致。错一处，用户复制粘贴就报错。
-
autoload.psr-4写的是"MyVendor\": "src/"，那文档里所有示例的use语句就必须是use MyVendorFooBar;，不能写成MyVendorFooBar或漏掉反斜杠 - 如果
composer.json里"require": { "php": "^8.1" }，文档里就不能出现match表达式示例（PHP 8.0+），更不能写str_contains()（PHP 8.1+）却不说清版本门槛 - 所有示例代码块必须能直接复制进
test.php运行：包含完整require 'vendor/autoload.php';、最小use列表、无框架辅助函数（如app()、config()）
最容易被忽略的一点：文档里的版本号（如 v1.2.0）必须和 Git tag 完全一致，且该 tag 对应的 commit 必须包含当时有效的 composer.json 和 docs/ 内容。改了文档不打新 tag，或者打了 tag 没 push，用户看到的永远是过期信息。
