SuperAPI AI 工具集

dotnet-documentation-strategy

写作与研究

查看项目

更新于 10-16 02:33

技能介绍

用途:为 .NET 项目选择文档工具,并给出配置与迁移建议。

主要能力:提供 Starlight(Astro 基础,新项目默认推荐)、Docusaurus(React 基础,插件丰富)、DocFX(社区维护,.NET 原生 XML 文档集成)的决策树与快速对比矩阵,覆盖学习曲线、内置搜索、版本化文档、i18n、Mermaid 支持、XML API 参考、托管与构建速度。给出各平台初始搭建命令与项目结构、配置示例,并说明 MarkdownSnippets 从源码注入经校验代码片段、Mermaid 在各平台的渲染方式,以及 DocFX 到 Starlight、Docusaurus 到 Starlight 的迁移步骤与检查清单。

使用方式:按项目上下文(库或应用、团队规模、现有生态)走决策流程;Starlight 用 npm create astro@latest -- --template starlight my-docs 创建,Docusaurus 用 npx create-docusaurus@latest my-docs classic,DocFX 用 dotnet tool install -g docfx 后 docfx init、docfx build、docfx serve _site;MarkdownSnippets 用 dotnet tool install MarkdownSnippets.Tool 安装,dotnet tool run mdsnippets 注入片段。

适用场景:新建 .NET 文档站、已有 DocFX 内容现代化、React 团队文档与博客、需要 XML 注释生成 API 参考的库项目。

限制:不覆盖文档站 CI/CD 部署、API 文档生成、XML 注释编写与 Mermaid 语法细节,这些由其他技能处理;DocFX 自 2022 年 11 月起由社区维护;DocFX 的 Mermaid 支持依赖模板,_enableMermaid 为模板约定而非官方属性;DocFX 元数据输出无直接 Starlight 等价物,需另行处理。具体版本假设与更多细节以资料为准,未提供的信息暂未提供。