技术文档
在你的仓库中编写并审查高质量的技术文档和代理指令文件。
使用场景/AI 知识库与文档
为 AI 提供最新库文档、Wiki、内部知识。减少幻觉,适合写代码、学新框架。
共匹配 608 个资源 · 第 3 / 13 页
知识库类 MCP 解决大模型最大的短板——知识过期与幻觉:Context7 按库与版本实时拉取官方文档和代码示例,DeepWiki 把任意 GitHub 仓库编译成可问答的 Wiki,自建方向则常用向量库 / 知识图谱 MCP 接入团队内部资料。
写代码时的典型链路:在 Cursor 里问「Next.js 15 的 fetch 缓存默认行为」→ Context7 MCP 返回对应版本的官方文档片段 → 生成的代码不再基于训练截止前的旧 API。升级大版本、试用新框架时收益最明显。
接入内部 Wiki 前先做权限隔离:为 AI 建立只读、按空间授权的检索通道,避免把全量机密文档无差别嵌入索引;对外服务同理,注意文档许可证与引用规范。
在你的仓库中编写并审查高质量的技术文档和代理指令文件。
需要处理数据库文档时使用。该 skill 提供自动化文档生成,含完整指导与自动化。触发语如 “generate docs”、“document schema”、“create database documentation”。
跨多个存储层(本地文件、MCP memory、向量存储、Git 仓库)的知识库管理、摄取、同步与检索。当用户想在知识系统中保存、整理、同步、去重或检索时使用。
通过 Context7 MCP 获取最新的库与框架文档,而不是依赖训练数据。当出现安装配置类问题、API 参考、代码示例,或用户点名某个框架(如 React、Next.js、Prisma)时触发。
当用户要求“update documentation for my changes”“check docs for this PR”“what docs need updating”“sync docs with code”“scaffold docs for this feature”“document this feature”“review docs completeness”“add docs for this change”“what documentation is affected”“docs impact”,或提到 docs/、docs/01-app、docs/02-pages、MDX、documentation update、API reference、.mdx 文件时使用。为根据代码变更更新 Next.js 文档提供引导式流程。
知识库管理、摄取、同步和跨多个存储层(本地文件、MCP内存、向量存储、Git仓库)的检索。当用户想要保存、组织、同步、去重或搜索其知识系统时使用。
按官方规范为 Expo SDK API 编写 TSDoc 注释。在 expo-* 包中引入新的面向用户的 TypeScript API 时必须使用——从一开始就正确记录 API,而非事后补。也用于改进现有文档。涵盖 @platform、@example、@deprecated、@default 注解、第三人称陈述式风格、blockquote 注记,以及文档生成的类型导出模式。
vdevelop
为 book、resources、ui、user-guide 和 cloud 项目撰写与更新 Medusa 文档 MDX 文件。适用于基于代码 diff 修改文档、新增页面、更新既有内容或更新组件示例。修改 www/apps/ 下任何 MDX 文件前务必先加载本技能。
vdevelop
按 .NET 规范编写与评审 XML API 文档。触发语:“给类写文档”“加 XML 注释”“写 XML documentation”“加三斜杠注释”“检查文档质量”“排查文档错误”“修复文档问题”“补全缺失文档”“清理 To be added 占位”,以及各类 API 文档请求。
通过并行评估与迭代改进循环来审查并改进文档。
只要任务涉及编写、审阅或编辑仓库中 `/docs` 目录下的文件或任何 `.md` 文件,都必须使用此技能。
Kubebuilder 在 docs/book/src/ 下文档的写作标准。在撰写或审查文档、教程、指南或插件文档时使用。
vnext
审查、改进、重写、撰写或规划 /docs 中的 Storybook 文档。当被要求审查文档、改进某个页面、重写文档、起草新文档或提供文档策略建议时使用。
渲染文档风格的 Cursor Canvas,把架构笔记、API 参考、走查教程与 how-to 组织成带分节、目录和交叉引用的可导航布局。当用户要求文档画布、文档总览、架构走查、API 参考页,或希望把结构化文档渲染为交互式画布时使用。
你是代码教育专家,擅长用清晰的叙述、可视化图表和分步拆解解释复杂代码,把晦涩概念变成各层级开发者都能理解的解释。
你是专注于从代码生成全面且可维护文档的文档专家。利用 AI 分析与行业最佳实践,生成 API 文档、架构图、用户指南与技术参考。
API 文档工作流:生成 OpenAPI 规范、编写开发者指南,并维护全面的 API 文档。
从代码生成全面、开发者友好的 API 文档,包括端点、参数、示例与最佳实践。
对 Python 代码强制执行 Google 风格的 docstring。
从源代码生成全面且准确的 API 文档。适用于创建或更新 API 文档、生成 OpenAPI 规范,或当用户提到 API 文档、端点或文档时使用。
从源代码生成全面且准确的 API 文档。适用于创建或更新 API 文档、生成 OpenAPI 规范,或在用户提到 API 文档、端点或说明时使用。
当用户要求为代码、API、库、仓库或软件项目生成、创建或改进文档时使用。支持 README 生成、API 参考文档、行内注释、架构文档、changelog 和开发者指南。触发于“document this code”“create a README”“generate API docs”“write developer guide”或为文档目的分析代码库的请求。
在 packages/docs 中撰写或编辑文档时使用。涵盖 Gitbook markdown 语法、特殊块、页面结构,以及 SUMMARY.md 目录。触发语包括 write docs、add documentation、docs page、gitbook、user manual。
vdevelop
为 Medusa 代码库中的 TypeScript 源文件添加和更新 TypeDoc(TSDoc)注释。覆盖 HTTP 类型、API 路由、UI 组件、数据模型、服务接口、JS SDK 方法、抽象 provider、workflow SDK 函数、core-flows 工作流与步骤,以及事件。为 packages/core/types/src/http、packages/medusa/src/api、packages/design-system/ui/src/components、packages/modules/*/src/models、packages/core/types/src、packages/core/js-sdk/src、packages/core/utils/src、packages/core/workflows-sdk/src/utils/composer、packages/core/core-flows/src 或 packages/core/utils/src/core-flows/events.ts 下的文件添加 TSDoc 注释时使用。
使用 JSDoc、TypeDoc 及面向不同读者的多层文档模式生成完整的 TypeScript 文档。适用于编写 API 文档、架构决策记录(ADR)、代码示例,以及 NestJS、Express、React、Angular、Vue 的框架专用模式。
所有 Cursor 文档的唯一权威来源与管家。负责本地文档存储、抓取、发现与定位。在查找、检索、搜索或解析 Cursor 文档时使用;支持按关键词、分类、标签或自然语言查询发现文档;从 llms.txt 抓取;管理索引元数据(关键词、标签、别名);或从文件系统重建索引。可运行脚本完成文档抓取、查找与解析。处理 doc_id 解析、关键词检索、自然语言查询、分类/标签过滤、别名解析、llms.txt 解析、供内部使用的 Markdown 小节抽取、基于哈希的漂移检测以及完善的索引维护。
通过 Context7 MCP 使用最新的库和框架文档,而非训练数据。当用户提出设置问题、API参考、代码示例或命名框架(例如 React、Next.js、Prisma)时激活。
从 modelcontextprotocol.io 获取最新的 MCP 规范与文档。训练数据可能过时——只要问题涉及 MCP 协议,默认使用本技能。触发场景:实现或调试 MCP 特性(sampling、elicitation、completion、tools、resources、prompts、传输层);SEP 或规范要求;MCP 传输行为(SSE、Streamable HTTP、重连、重试);授权/OAuth;一致性测试失败;能力协商;消息 Schema。仅在与 MCP 协议零依赖的纯 Kotlin、构建系统或重构任务时跳过。拿不准时就触发
通过 Context7 MCP 获取最新的库与框架文档,而不是依赖训练数据。当出现安装配置类问题、API 参考、代码示例,或用户点名某个框架(如 React、Next.js、Prisma)时触发。
帮助用户在 VS Code 工作区中创建完整项目结构的全面设置步骤。本工具面向整体项目的初始化与脚手架搭建,而非创建单个文件。适用:从零创建完整新项目;搭建整框架(TypeScript 项目、React 应用、Node.js 服务等);初始化具备完整结构的 Model Context Protocol(MCP)服务器;按规范脚手架创建 VS Code 扩展;设置 Next.js、Vite 等框架项目;用户要求新项目、创建工作区或设置某框架项目;需要建立含依赖、配置文件与目录结构的完整开发环境。不适用:创建单个文件或少量代码片段;向已有项目添加单个文件;修改既有代码库;用户要求创建一个文件。
文档约定(非个人化文风、格式、示例中使用 Vitest、结构、链接)。在撰写、编辑或审查指南、教程或 README 时使用。
按 Sentry 的 MDX stories 格式创建或更新组件文档。当被要求“document a component”“add stories”“write component docs”“create an mdx file”“add a stories.mdx”,或为设计系统组件编写文档时使用。生成结构化 MDX,包含实时示例、无障碍指引,以及由 TypeScript 类型自动生成的 API 文档。
编写数据库模式文档、ERD 图、表关联关系、索引与约束说明。适用于记录数据库结构、绘制 ERD 图或编写表文档。
编写与修订 Remotion 文档的指引。在新增文档页、编辑 packages/docs 下的 MDX 文件或撰写文档正文时使用。
查询 Microsoft 官方文档,在 Azure、.NET、Agent Framework、Aspire、VS Code、GitHub 等范围内查找概念、教程与代码示例。默认使用 Microsoft Learn MCP;对 learn.microsoft.com 之外的内容使用 Context7 与 Aspire MCP。
查询 Microsoft 官方文档,在 Azure、.NET、Agent Framework、Aspire、VS Code、GitHub 等范围内查找概念、教程与代码示例。默认使用 Microsoft Learn MCP;对 learn.microsoft.com 之外的内容使用 Context7 与 Aspire MCP。
查询 Microsoft 官方文档,在 Azure、.NET、Agent Framework、Aspire、VS Code、GitHub 等范围内查找概念、教程与代码示例。默认使用 Microsoft Learn MCP;对 learn.microsoft.com 之外的内容使用 Context7 与 Aspire MCP。
查询 Microsoft 官方文档,在 Azure、.NET、Agent Framework、Aspire、VS Code、GitHub 等范围内查找概念、教程与代码示例。默认使用 Microsoft Learn MCP;对 learn.microsoft.com 之外的内容使用 Context7 与 Aspire MCP。
查询 Microsoft 官方文档,在 Azure、.NET、Agent Framework、Aspire、VS Code、GitHub 等范围内查找概念、教程与代码示例。默认使用 Microsoft Learn MCP;对 learn.microsoft.com 之外的内容使用 Context7 与 Aspire MCP。
查询 Microsoft 官方文档,在 Azure、.NET、Agent Framework、Aspire、VS Code、GitHub 等范围内查找概念、教程与代码示例。默认使用 Microsoft Learn MCP;对 learn.microsoft.com 之外的内容使用 Context7 与 Aspire MCP。
查询 Microsoft 官方文档,在 Azure、.NET、Agent Framework、Aspire、VS Code、GitHub 等范围内查找概念、教程与代码示例。默认使用 Microsoft Learn MCP;对 learn.microsoft.com 之外的内容使用 Context7 与 Aspire MCP。
查询 Microsoft 官方文档,在 Azure、.NET、Agent Framework、Aspire、VS Code、GitHub 等范围内查找概念、教程与代码示例。默认使用 Microsoft Learn MCP;对 learn.microsoft.com 之外的内容使用 Context7 与 Aspire MCP。
查询 Microsoft 官方文档,在 Azure、.NET、Agent Framework、Aspire、VS Code、GitHub 等范围内查找概念、教程与代码示例。默认使用 Microsoft Learn MCP;对 learn.microsoft.com 之外的内容使用 Context7 与 Aspire MCP。
查询 Microsoft 官方文档,在 Azure、.NET、Agent Framework、Aspire、VS Code、GitHub 等范围内查找概念、教程与代码示例。默认使用 Microsoft Learn MCP;对 learn.microsoft.com 之外的内容使用 Context7 与 Aspire MCP。
查询 Microsoft 官方文档,在 Azure、.NET、Agent Framework、Aspire、VS Code、GitHub 等范围内查找概念、教程与代码示例。默认使用 Microsoft Learn MCP;对 learn.microsoft.com 之外的内容使用 Context7 与 Aspire MCP。
查询 Microsoft 官方文档,在 Azure、.NET、Agent Framework、Aspire、VS Code、GitHub 等范围内查找概念、教程与代码示例。默认使用 Microsoft Learn MCP;对 learn.microsoft.com 之外的内容使用 Context7 与 Aspire MCP。
查询 Microsoft 官方文档,在 Azure、.NET、Agent Framework、Aspire、VS Code、GitHub 等范围内查找概念、教程与代码示例。默认使用 Microsoft Learn MCP;对 learn.microsoft.com 之外的内容使用 Context7 与 Aspire MCP。
查询 Microsoft 官方文档,在 Azure、.NET、Agent Framework、Aspire、VS Code、GitHub 等范围内查找概念、教程与代码示例。默认使用 Microsoft Learn MCP;对 learn.microsoft.com 之外的内容使用 Context7 与 Aspire MCP。
Context7 以库名+版本精确取文档切片并结构化给模型,省去抓取清洗、上下文更聚焦;直接搜索适合无固定库的泛调研。
常见三条路:向量库 MCP(如 Qdrant / Chroma / pgvector)做语义检索、Notion / Confluence 官方 MCP 直连、或自建 RAG 服务包一层 MCP。按数据敏感级别选。
会增加一次工具调用的延迟(通常几百毫秒),但换来更少返工。控制返回片段大小、只挂载需要的知识库即可。