SuperAPI AI 工具集

docs-write

写作与研究

查看项目

更新于 10-16 08:04

技能介绍

用途:在编写或编辑文档(Markdown、MDX 等)时,按 Metabase 的对话式、清晰、面向用户的风格产出内容。写作时使用 references/metabase-style-guide.md 指南设定默认语气、结构与格式。

主要能力与写作要点:先明确读者是谁、需要什么、学习时常见的疑问;匹配受众复杂度,不把难事过度简化,也不把简单事复杂化,让读者快速得到答案。流程上,草稿以“告诉同事”的方式写出步骤与解释,先说做什么再解释为什么;标题直接表意,例如“Set SAML before adding users”。编辑时朗读检查语气,删除不直接帮助读者的内容,确保每段只有一个明确目的,并验证示例确实可用。润色时链接描述要有意义(不用“here”),反引号只用于代码或变量,UI 元素用粗体,使用美式拼写与序列逗号,图片尽量少且聚焦。

格式与用法:常见模式为指令用代码块逐步呈现命令;标题要具体不空泛也不啰嗦;链接用描述性文字。编辑后运行格式化命令:yarn prettier --write <file-path>,以保证文档格式一致。

需避免:把任务描述为“easy”;谈论 Metabase 功能时用“we”;正式用语如 utilize、reference、offerings;过多感叹号;把动作埋在解释里;无法运行的代码示例;会过时的数字。

限制:资料未提供该技能的具体安装步骤、平台依赖、收费方式与适用范围,暂未提供。以上内容仅依据给定资料整理。