背景
当前 profile/README.md 存在信息过载问题:试图同时做"产品目录"和"品牌叙事",导致篇幅冗长、中英内容高度重复。作为 GitHub 组织门户,应首先做到简洁清晰,让访问者快速理解"我们是谁、有什么、怎么用"。
调研过程
对 8 个知名开源组织的 GitHub Profile README 进行了调研(通过 gh api 获取):
成功获取(7 个)
| 组织 |
长度 |
风格 |
关键特点 |
| Microsoft |
短(~15行) |
极简企业型 |
Banner 图 + 短段落 + 链接列表 + Code of Conduct,无 emoji/badge/表格 |
| LangChain |
中(~50行) |
产品目录型 |
居中 logo(dark/light 切换)+ 社交 badge + 产品分层列表,信息密度高 |
| Docker |
长(~70行) |
品牌叙事型 |
大量 emoji 作 section 图标,表格化链接,品牌双关语 "Whalecome" |
| Prisma |
长(~80行) |
品牌叙事型 |
<details> 折叠区保持首屏简洁,UTM 追踪链接,提供可复制 badge |
| GitHub |
长(~80行) |
品牌叙事型 |
数据驱动叙事(2.5M commits),折叠彩蛋,底部 "psst" 惊喜 |
| Grafana |
短(~25行) |
极简企业型 |
全宽壁纸图 + 一段话 + LGTM 产品列表 + 招聘 CTA |
| Vercel |
极短(1行) |
— |
仅 "Shared community files for the Vercel organization." |
未设置 Profile README(5 个)
Anthropic、OpenAI、Google、Hugging Face、Meta Llama — AI 领域头部组织均未设置 Org Profile README。"极简"本身就是一种姿态。
四种风格模式
| 模式 |
代表 |
适合场景 |
核心理念 |
| 极简企业型 |
Microsoft, Grafana |
品牌认知度高的大公司 |
让产品和文档为自己说话 |
| 产品目录型 |
LangChain, Prisma |
需要快速传达产品矩阵的成长型公司 |
产品全景,按需取用 |
| 品牌叙事型 |
Docker, GitHub |
有强烈品牌文化和社区的公司 |
Profile 是品牌文化的延伸 |
| 无 README |
Anthropic, OpenAI 等 |
品牌认知度极高的组织 |
代码仓库本身就是最好的 profile |
现有 README 问题
| # |
问题 |
严重度 |
| 1 |
中英双语平铺导致篇幅翻倍,核心信息高度重复 |
高 |
| 2 |
行业 Workflow 示例(电商/文档处理)属于文档站内容,不是门户职责 |
中 |
| 3 |
"为什么选择阿里云百炼"段落属于自我推销 |
中 |
| 4 |
Footer HTML 标签不匹配(孤立 </a>) |
高 |
| 5 |
URL 中裸 & 参数分隔符(3处) |
中 |
| 6 |
英文 Contributing 段落不完整,只有一个 bullet |
低 |
| 7 |
生态链接在英中两段各出现一次 |
低 |
| 8 |
钉钉二维码放在英文区,英文用户无法理解 |
低 |
Proposal
采用「产品目录型」风格(参考 LangChain + Prisma 折叠技巧),重构方案如下:
设计原则
- 首屏即可行动 — Banner → 一句话定位 → Quick Start,访问者 10 秒内可开始使用
- 中文折叠 — 用
<details> 折叠中文内容,保持首屏干净且信息不丢失
- 去营销化 — 删除行业 Workflow 和"为什么选择"段落,让产品链接自己说话
- 合并重复 — 生态链接、仓库列表只出现一次(英文主版本)
- 修复已知 bug — HTML 标签、URL 裸
&
页面结构(重构后)
Banner 图(可选 dark/light 切换)
一句话定位 + Badge 行
生态合作链接行
───────────────
Quick Start(安装 → 认证 → 使用示例)
Repositories 表格
Capabilities 表格
───────────────
<details> 中文版(关于、快速开始、核心项目、核心能力、社区二维码)
Contributing
Footer
与现有版本对比
| 维度 |
现有 |
重构后 |
| 首屏信息 |
双语锚点 → 双语 About → 双语仓库表 |
Banner → 一句话 → Quick Start |
| 中文内容 |
平铺占一半篇幅 |
<details> 折叠 |
| 行业 Workflow |
有 |
删除 |
| "为什么选择" |
有 |
删除 |
| 生态链接 |
英中各一次 |
合并到顶部一处 |
| 钉钉二维码 |
英文区 |
移入中文折叠区 |
| Footer bug |
有 |
已修复 |
URL 裸 & |
3 处 |
全部清理 |
此 issue 由 qwen-code 自动调研生成,follow-up PR 将随后提交。
Signed-off-by: qwen-code
背景
当前
profile/README.md存在信息过载问题:试图同时做"产品目录"和"品牌叙事",导致篇幅冗长、中英内容高度重复。作为 GitHub 组织门户,应首先做到简洁清晰,让访问者快速理解"我们是谁、有什么、怎么用"。调研过程
对 8 个知名开源组织的 GitHub Profile README 进行了调研(通过
gh api获取):成功获取(7 个)
<details>折叠区保持首屏简洁,UTM 追踪链接,提供可复制 badge未设置 Profile README(5 个)
Anthropic、OpenAI、Google、Hugging Face、Meta Llama — AI 领域头部组织均未设置 Org Profile README。"极简"本身就是一种姿态。
四种风格模式
现有 README 问题
</a>)&参数分隔符(3处)Proposal
采用「产品目录型」风格(参考 LangChain + Prisma 折叠技巧),重构方案如下:
设计原则
<details>折叠中文内容,保持首屏干净且信息不丢失&页面结构(重构后)
与现有版本对比
<details>折叠&此 issue 由 qwen-code 自动调研生成,follow-up PR 将随后提交。
Signed-off-by: qwen-code