SuperAPI AI 工具集

docs-as-code

写作与研究

查看项目

更新于 10-16 00:23

技能介绍

用途:该技能面向“文档即代码”工作流,用于规划与实现文档流水线自动化,帮助团队按既有标准构建、测试与发布文档。触发场景包括文档流水线任务、方案规划与最佳实践参考。

主要能力:围绕四项原则展开——版本控制(文档与代码同仓、基于分支更新)、评审流程(Pull Request、技术评审与写作风格评审)、自动化测试(样式与语法检查、链接校验、构建验证)、持续部署(合并后自动发布、PR 预览部署、版本化发布)。技能提供文档工具对比(Docusaurus、MkDocs、Sphinx、Hugo、Astro、VitePress、Jekyll 及其适用场景与构建速度),给出 Docusaurus 与 MkDocs 的目录结构和配置示例,附带 GitHub Actions 与 Azure DevOps 的管道模板,以及 markdownlint 与 Vale 的配置,并展示从代码 XML 注释生成 API 文档、OpenAPI 文档生成的做法。

必要用法:实施前先调用 docs-management 技能获取文档模式,并通过 MCP 服务器(context7 用于 docusaurus/mkdocs)核实工具版本,确保指导基于当前最佳实践。命令与配置需保持原样,例如 npm ci、npx markdownlint-cli2 "docs/**/*.md"、mkdocs build --strict。

适用场景:需要将文档纳入代码仓库、用流水线自动校验与发布的工程团队,以及希望统一工具链与文档质量的文档维护者。

限制:资料未说明该技能的授权方式、收费、安装命令与运行环境要求;工具性能与适用性描述来自资料原文,未给出具体版本兼容范围。部分示例配置内容在资料中不完整,暂未提供完整细节。