你为同一款工具分别生成适配 GitHub、PyPI、飞书文档三种平台的 README 时，常常会发现 DeepSeek 输出的内容要么完全按照 GitHub 格式写死，要么标题层级与链接语法混杂不清，一旦复制到目标平台便出现报错或渲染异常。这一难题在实际开发中相当普遍——因为不同平台对 README 的语法规范差异显著，稍有不慎就需要反复调整。下面直接给出具体可行的解决方案。
明确各平台 README 的硬性约束
GitHub README 必须以 ## 开头的二级标题划分段落，禁止使用任何 HTML 标签，所有链接必须严格按照 [文字](url) 格式编写；PyPI 页面不支持 GitHub 风格的 emoji 和表格，首行必须为纯文本形式的项目名称，且要求 【description 字段必须与 README 首段内容完全一致】；飞书文档支持嵌入卡片与 @ 成员功能，但会自动过滤掉反引号包裹的代码块，需改用「代码段」组件进行标识。
如果跳过此步骤的检查，后续生成的各版本都将无法通过平台校验——例如 PyPI 上传时因首行包含 emoji 而被直接拒绝解析。因此务必先逐条梳理清楚各项规则，再着手生成内容。
用 JSON 模板固化三平台字段映射
新建一个 readme-template.json 文件，填入以下结构：
{ "platform": "{target_platform}", "project_name": "{tool_name}", "brief_desc": "{one_line_summary}", "install_cmd": "pip install {tool_name}", "usage_example": "from {tool_name} import main; main()", "compatibility": ["Python 3.8+", "Linux/macOS/Windows"], "license": "MIT" }
其中 {target_platform} 是唯一需要手动替换的变量，取值只能是 github、pypi 或 feishu——填写错误会导致模板引擎选用不正确的渲染规则。这套模板的优势在于，所有平台的变量来源实现了统一，后续生成各版本时只需替换平台变量即可，不会出现字段冲突或内容矛盾。
分平台生成具体版本
方法一：GitHub 版本（强依赖 Markdown 语法）
向 DeepSeek 提交如下提示词：“请严格按照 GitHub 最新规范生成 README：首行为项目名称（不带 #），第二行为 brief_desc 纯文本描述；使用 ## 分隔 Installation、Usage、Compatibility、License 四个章节；Installation 章节只写入 pip install 命令；Usage 章节必须包含 Python 调用示例代码块，并用三个反引号包裹；Compatibility 列表每一项前加 - ，不加序号。”
方法二：PyPI 版本（零容忍格式错误）
输入以下提示词：“生成 PyPI 兼容的 long_description 字段内容：首行必须与 brief_desc 完全相同，不加任何标点符号或换行；随后空一行；接着写 Installation（仅包含 pip install 命令，不使用代码块）；再空一行；写 Usage（用普通缩进代替代码块，函数调用描述为 ‘main() 函数接收 dict 参数’ 这类说明性语句）；最后写 Compatibility（用英文逗号分隔，例如 ‘Python 3.8+, Linux, macOS, Windows’）。”
方法三：飞书文档版本（需激活协作能力）
第一步：先让 DeepSeek 输出带有占位符的初稿：“生成飞书文档风格的 README：在 Installation 步骤末尾插入「点击此处下载配置模板」超链接占位符；在 Usage 示例后添加一行‘@技术负责人 审核接口参数’；Compatibility 行末加上 ? 图标。”
第二步：利用飞书多维表格批量替换占位符——将「点击此处下载配置模板」替换为真实的飞书云文档链接，系统会自动同步更新所有关联页面。
