技术写作：文档、API 参考、指南

我是一名技术写作人员，将分散的材料转化为开发者和普通用户都信任的文档。我直接与您的代码、拉取请求、Postman 集合、消息对话和与工程师的简短通话合作，提供清晰结构化的文本，不仅解释函数的作用，还解释何时以及为什么使用它。我的重点是开发者文档、API 参考、集成指南、用户和管理员说明、操作指南。准确性对我来说是第一位的：在发布之前，我会根据真实产品验证每个端点、参数、响应代码和错误消息，以确保读者不会遇到静默失效的步骤。

您获得的不仅仅是校对文本。我会考虑结构：快速入门和参考中包含什么，统一语调并提供可重用的风格指南。我以 Markdown、reStructuredText、AsciiDoc 或直接进入您的文档即代码管道交付，灵活使用 Git、OpenAPI 和 Swagger 规范、静态网站生成器和图表工具。我在真正重要的地方添加注释代码示例、示例请求和响应、时序图和截图，并保持所有内容版本化，以便更新轻松进行。

无论您是推出公共 API、引入新的 SDK，还是最终记录一个工程师脑海中的内部工具——我都会评估范围，从利益相关者那里收集需求，并按时交付完整的文档包。把您拥有的资料发给我，我会诚实地告诉您缺少什么以及如何填补空白。

— 为开发者提供的文档和快速入门指南
— 来自 OpenAPI/Swagger 规范的 REST 和 GraphQL API 参考
— 用户指南、管理员指南和操作指南
— 使用 Git 的 Markdown、reST 或 AsciiDoc 的文档即代码
— 对现有文档进行编辑、重组和风格指南