Kotlin 文档把学习路径、语言指南、平台内容、API Reference 和迁移文档组合成一个生产体系。
结构分析采用 DocLint 规则,编辑质量则依据官方页面和 JetBrains 开源源码人工评估。
研究范围
基于 2026 年 8 月 15 日可公开访问的资料。
Markdown 主题
.topic 文件
Tour 课程
稳定版本
评价标准
它不是一本巨型手册
学习、任务、概念、参考和版本内容分工明确。
| 用户任务 | 入口 | 获得什么 |
|---|---|---|
| 试用 | Tour 与 Playground | 无需安装 IDE。 |
| 开始项目 | Get started | 按平台和目标选择路径。 |
| 理解语言 | Language guide | 概念与语法。 |
| 查 API | Dokka | 独立参考资料。 |
| 升级 | What’s new 与迁移 | 版本变化单独维护。 |
| 开发库 | KDoc 与作者指南 | 公共 API 质量。 |
技术实现
成熟的 docs-as-code 架构。
Markdown + Writerside
内容与导航。
多仓库
外部文档模块接入。
CI
可运行示例自动校验。
发布
TeamCity 构建并后处理。
编辑评分:82/100
入门、示例和工程体系很强,官方本地化和 troubleshooting 是明显短板。
入门
9/10
信息架构
9/10
示例
10/10
参考
9/10
版本
9/10
故障排查
7/10
查找
8/10
清晰度
8/10
工程化
10/10
本地化
3/10
82/100
最强的部分
好的表达与需要修改的表达
工程质量不能替代文字编辑。
还缺什么
演进
值得借鉴的实践
| 实践 | 借鉴 |
|---|---|
| 导航即代码 | 对信息架构做版本管理。 |
| 示例可验证 | 在 CI 中测试 code samples。 |
| 分离内容类型 | 不要混合 tutorial、concept、reference。 |
| Release docs | 产品更新同时维护 migration。 |
| 用文档测试设计 | 复杂 onboarding 往往暴露复杂 API。 |
| AI 使用明确 skills | 给 agent 可验证的流程。 |
一手资料
[K1]kotlinlang.org/docs/reference/[K2]kotlinlang.org/docs/getting-started.html[K3]kotlinlang.org/docs/kotlin-tour-welcome.html[K4]kotlinlang.org/docs/null-safety.html[K5]kotlinlang.org/docs/collections-overview.html[K6]kotlinlang.org/docs/coding-conventions.html[K7]kotlinlang.org/docs/api-guidelines-informative-documentation.html[K8]kotlinlang.org/docs/kotlin-doc.html[K9]kotlinlang.org/docs/contribute.html[K10]kotlinlang.org/docs/whatsnew21.html[K11]kotlinlang.org/docs/whatsnew22.html[K12]kotlinlang.org/docs/whatsnew2220.html[K13]kotlinlang.org/docs/whatsnew24.html[G1]github.com/JetBrains/kotlin-web-site[G2]github.com/JetBrains/kotlin-web-site/blob/master/docs/writerside.cfg[G3]github.com/JetBrains/kotlin-web-site/blob/master/docs/kr.tree[G4]github.com/JetBrains/kotlin-web-site/blob/master/.github/workflows/verify-samples.yml[G5]github.com/JetBrains/kotlin-web-site/blob/master/.teamcity/documentation/builds/WritersideBuilder.kt[G6]github.com/JetBrains/kotlin-web-site/blob/master/.teamcity/documentation/builds/KotlinWithCoroutines.kt[G7]github.com/JetBrains/kotlin-web-site/blob/master/.claude/skills/add-writerside-doc-module/SKILL.md[G8]github.com/JetBrains/kotlin-web-site/blob/master/.claude/skills/add-api-reference/SKILL.md
结论
Kotlin 最强的是文档生产体系,而不仅是单篇页面。
学习、概念、reference 与 migration 的分工清晰。
下一步最值得加强的是本地化、troubleshooting 和文字精简。
Kotlin 展示了 2026 年成熟的文档工程模型:示例可验证,内容分层明确,维护流程可自动化。
