SuperAPI AI 工具集

docs-writing

写作与研究

查看项目

更新于 10-16 00:05

技能介绍

用途:为 maplibre-compose 仓库撰写或编辑文档、KDoc、贡献者指南和 PR 描述。写作面向可能以英语为第二语言的读者:库使用者通常熟悉 Compose,但需要解释 MapLibre 概念;贡献者熟悉 Kotlin Multiplatform,但需要了解项目特定决策的理由。

主要能力与写作要求:先给出读者需要的事实、操作或决策;使用具体名词、直接动词和明确条件;避免宣传性语言、套话和掩盖 API 行为的比喻;包含理解主题所需的细节。解释用段落,步骤或并列项用列表,比较用表格;标题使用句首大写,并标识可导航的章节;链接到已有说明而非重复。

文档站点:docs/src/content/docs/ 下的页面遵循 Diátaxis 结构——Getting started 帮助新用户集成可运行地图;Guides 完成特定任务并在出现选择时解释;Concepts 解释行为与设计;API reference 来自 KDoc,定义公共 API 契约。应选择页面的主要目的并保持聚焦,在站点介绍常见路径并链接到 API 细节;当平台差异、条件和实现细节影响读者决策或完成任务时需包含。

代码示例:页面从 demo-app/common/src/*/kotlin/org/maplibre/compose/docsnippets/ 中的 // #region 块导入 Kotlin 示例,这些示例随 demo 应用一起编译。应新增或更新片段区域,而不是在页面中嵌入未经测试的 Kotlin 示例。面向文件的代码块以目标文件名命名,如 build.gradle.kts 或 App.kt。

KDoc 与 PR:KDoc 定义调用者需要的行为、参数语义、生命周期要求和平台限制。PR 描述遵循 .github/PULL_REQUEST_TEMPLATE.md 和 AI_POLICY.md,说明评审者理解变更所需的内容,细节与复杂度成比例,并准确报告验证情况。

限制:资料未提供该技能的具体安装命令、收费方式或平台支持范围。