技术文档助手

高效管理技术文档项目，提供结构化模板。 write-docs 插件提供了一种高效的方式来启动和管理文档项目，特别适用于技术文档的撰写。用户可以选择不同类型的文档，如 API 文档，系统文档等，并根据目标受众的需求获取结构化的模板和大纲。该命令不仅帮助用户定义文档的目标受众，还提供最佳实践指导，以确保文档的专业性和清晰度。 通过使用此插件，用户能够迅速获取如 OpenAPI/Swagger 模板、端点文档模板及身份验证指南等资源，确保文档内容的全面性和准确性。预计文档长度为 30-50 页，完成时间为 2-4 周，适合需要详细记录 REST、GraphQL 等 API 的开发者和技术团队。此插件的设计旨在提升文档撰写的效率和质量，助力技术交流的顺畅进行。

高效生成可运行的代码示例和实现模式。 generate-examples 插件提供了一个高效的代码示例生成工具，旨在自动生成可运行的代码示例、代码片段以及 API 和功能的实现模式。用户可以通过简单的命令 `/generate-examples` 来启动该功能，并根据需求描述所需的功能、目标编程语言、用例或场景及复杂性级别，从而获得相应的示例。 该插件支持多种编程语言，生成的示例包括完整的、经过测试和验证的代码，涵盖真实场景中的常见任务、错误处理模式及最佳实践。此外，用户还可以获取 SDK 使用示例、API 客户端示例、配置文件模板及故障排除示例等，确保代码的生产就绪状态和高效性。通过这一工具，开发者能够更快速地实现功能，提升开发效率。

快速生成符合 OpenAPI/Swagger 标准的 API 文档。 API模板生成器旨在快速生成符合 OpenAPI/Swagger 标准的 API 文档结构，便于记录和管理 API。通过执行命令 `/api-template`，用户将获得一个基本的 OpenAPI 规范示例，包括 API 名称、版本、描述以及服务器信息。此外，插件还提供完整的端点模板，用户可以根据需求进行扩展和修改。该工具不仅提升了 API 文档的专业性，还简化了文档编写过程，使开发者能够专注于 API 的设计与实现。通过使用此插件，团队能够确保 API 文档的规范性和一致性，从而提高协作效率和代码可维护性。

专业撰写API文档、用户指南和教程的智能体。 专注于 API 文档、用户指南、教程和代码示例的专家技术写作者。帮助创建清晰、全面且结构良好的技术内容。