先写用途
标题说明页面内容;简介说明可做的事。按钮使用“打开作品”“阅读指南”“下载源码”等明确动作,避免交付口吻和空泛评价。
区分事实与计划
已可访问的内容与计划中的功能分开写。开发候选不能写成正式版本;没有数据支持时不标注完成率、性能提升或模型评分。
一处维护,多处链接
README 提供总览与启动入口;项目概览解释用途;资料页提供操作步骤;更新页记录变化。维护日志和历史报告留在 docs/,不重复铺到访客页面。
保留来源
保留署名、许可、素材来源和历史链接。实验展示说明提示词、模型与已知设置,不将推测写成记录。
语言入口与原文
中文 README 的网站页面入口使用 lang=zh,英文 README 使用 lang=en。网页按钮和提示补齐对应译文;原始提示词、代码、许可及未翻译文章保留原文,不把中文隐藏来冒充翻译完成。