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