为何文档至关重要
清晰的文档 = 满意的开发者。
文档是产品的主要交互界面,因此清晰、简洁且结构良好的文档至关重要。作为一名技术作家,我拥有丰富的文档编写经验,能够有效减少支持工单、消除工程摩擦并提升用户体验。
核心专长
API 与 SDK 文档
专注于 RESTful API、OpenAPI/Swagger 规范、Postman 集合以及全面的 SDK 参考指南,旨在简化开发者入门流程并加速集成。
代码化文档与文档运维 (DocOps)
精通基于 Git 的工作流、Markdown、静态网站生成器(Docusaurus)、Vale 风格的自动化代码检查,以及 CI/CD 验证,以确保文档维护达到软件级别的严谨性。
概念与架构指南
专长于交互式系统架构图(Mermaid.js)、标准操作流程(SOP)以及深度概念指南,能够将复杂的软件设计转化为清晰的思维模型。
AI 与智能文档
设计AI文档助手,构建兼顾大语言模型检索与人类可读性的知识库,并为现代AI工具编写基于提示工程的工作流。
信息架构与本地化
构建可扩展的内容分类体系,优化开发者的导航流程,并管理全球工程团队间的多语言本地化(i18n)工作流。
核心工具包与技术
OpenAPI / SwaggerPostmanDocusaurusMarkdown / MDXMermaid.jsVale 代码检查Git / GitHubCI/CD 与 DocOpsi18n 本地化AI文档助手