为何文档至关重要
清晰的文档 = 满意的开发者。
文档是产品的主要交互界面。清晰、简洁且结构合理的文档至关重要。我曾起草过 API 参考文档、教程、案例研究和产品指南,这些内容有效减少了支持工单数量,降低了工程实施的阻力,并提升了用户体验。
核心专长
API 与 SDK 文档
RESTful API、OpenAPI/Swagger 规范、Postman 集合以及 SDK 参考指南,帮助开发者更快上手并完成集成。
代码化文档与文档运维 (DocOps)
采用基于 Git 的工作流、Markdown、Docusaurus、Vale 风格代码检查以及 CI/CD 验证,以软件级别的严谨性维护文档。提交信息和拉取请求描述。
概念与架构指南
交互式系统架构图(Mermaid.js)、标准操作流程(SOP)以及深入浅出的概念指南,将软件设计转化为清晰的思维模型。
AI 与智能文档
设计 AI 文档助手,并构建适合大型语言模型(LLM)检索且便于人类阅读的知识库。针对 RAG 架构的提示词优化工作流及案例研究。
信息架构与本地化
构建内容分类体系,并在全球工程团队中管理多语言本地化(i18n)工作流程。优化开发者导航体验。
教程与产品文档
针对命令行工具及其 MCP 服务器的分步教程、安装指南和产品文档。
核心工具包与技术
OpenAPI / SwaggerPostmanDocusaurusMarkdown / MDXMermaid.jsVale 代码检查VS CodePythonMCPDeepL / LaraGit / GitHubCI/CD 与 DocOpsi18n 本地化AI文档助手