SuperAPI AI 工具集

component-overview-page

写作与研究

查看项目

更新于 10-16 07:14

技能介绍

用途:该技能用于创建或修改 Telerik UI for Blazor 组件文档中的 overview.md 文件,规范组件概览页的结构与语言。

主要能力与结构要求:概览页包含若干固定章节。Introduction 位于主标题之后,说明组件是什么、解决什么问题,并提及一两个最有价值的基础功能,同时链接到 telerik.com 上对应组件的营销页,URL 格式为 https://www.telerik.com/blazor-ui/component-name。可选章节为与相似组件的对比,说明使用场景、优势与主要差异,帮助读者选择组件。Basic component configuration 列出在接近真实场景中配置并显示组件所需的最少步骤。Major Features 最多列 7 个主要功能,每个用 H2 标题、不超过 3 句话的段落,并链接到专门的功能文章,链接关键词需利于 SEO,按重要性降序、实现顺序升序排列。若功能超过 7 个,用 More Features 章节以无序列表列出 3 至 8 个次要功能并各自链接。API Reference 章节只含一句简述和指向组件 API 参考的链接;若组件为泛型,链接需按泛型参数数量以 -1 或 -2 结尾。Component Reference 说明如何用 @ref 属性引用组件以调用组件方法,并附一小段代码。Next Steps 列出最值得继续阅读的文档页;See Also 列出在线演示、API 参考或重要 KB 文章等相关资源。整体结构应遵循 Overview Page Template,并将模板中的 Component Name、component-name、componentname 替换为实际组件名及对应大小写格式。

链接规范:指向同一文档站内其他页面的链接应使用目标 .md 文件元数据中的 slug 值;提到有独立文档页的组件或功能时应添加链接。

关键限制:overview.md 中绝不允许出现参数表或参数章节,例如“Component Name Parameters”“Breadcrumb Parameters”等标题,也不得以表格形式列出或描述单个 API 成员或组件参数;不得写详细参数文档,参数细节只属于 API 参考。概览页应聚焦功能与概念,而非罗列参数。

适用场景:生成或修改 Telerik Blazor 组件概览文档时使用。资料未提供具体组件示例、安装命令或平台限制等更多信息。