**摘要**本文档面向 ws-http 项目的 doc/ 目录技术文档建设提出一套以英文为默认主文档的开源文档方案。全文分为三步第一步深度扫描 src/ 源码结合中文注释理解 Core/HttpClient、Request、Response、Functional/Scenario、Assertion、Plugin/、NanoGpt/ 等核心模块的职责与业务逻辑并输出《英文文档模块规划表》第二步在确认规划后为每个模块生成包含 Overview、Key Components、Usage Examples、Configuration、Dependencies 五部分的英文 Markdown 文档第三步更新根目录 README.md补充指向 doc/ 各模块文档的导航链接。文档强调术语准确、示例真实可运行并遵循 GitHub 相对路径规范。 你现在的任务是完善 ws-http 项目的 doc/ 目录技术文档。鉴于项目源码注释主要为中文请严格遵循“以英文为默认主文档”的开源标准按以下步骤执行 ### 第一步深度扫描与模块规划 1. **读取源码**完整扫描 src/ 目录重点分析 Core/ (HttpClient, Request, Response), Functional/ (Scenario, Assertion), Plugin/, NanoGpt/ 等核心模块。 2. **理解逻辑**结合中文注释理解各类的职责、方法参数含义及业务逻辑但**输出文档时必须使用专业、地道的技术英语**。 3. **输出规划**列出一份《英文文档模块规划表》包含建议的文件名如 core-client.md、模块职责简述、关键 API 列表。 - *注意*暂不生成具体文件仅输出规划清单供我确认。 ### 第二步生成全量英文文档待我确认后执行 确认规划后请在 doc/ 目录下为每个模块创建对应的英文 Markdown 文件。每份文档必须包含 - **Overview**: 模块的核心设计意图与职责。 - **Key Components**: 核心类/接口的详细说明参数与返回值类型需对齐 PHP 7.4 规范。 - **Usage Examples**: 提供基于真实代码的可运行 PHP 示例严禁编造不存在的方法。 - **Configuration**: 关键配置项说明。 - **Dependencies**: 模块间的依赖关系。 ### 第三步根目录 README 更新 - 更新根目录 README.md英文版增加指向 doc/ 下各模块文档的导航链接。 - 确保所有链接路径符合 GitHub 相对路径规范。 ### 约束条件 - **语言风格**英文文档需符合国际开源社区习惯术语准确如将“场景”译为 Scenario“断言”译为 Assertion。 - **真实性**所有代码示例必须从 src/ 中的真实类和方法签名提取确保可运行。 - **忽略中文输出**此阶段仅生成英文文档中文配套文档将在后续步骤单独生成。 请先执行第一步输出《英文文档模块规划表》。