跳到主要内容

技术写作作品集

这是一个专门展示我的技术写作作品集中软件相关样本的作品集。它全面展示了软件文档样本，所有样本均使用 Docusaurus 完全以 Markdown 编写和发布。在这里，您可以找到开发人员指南、API 参考以及用于创建这些文档的工作流程的见解。

备注

由于签署了保密协议 (NDA)，我无法分享大部分工作内容，但此作品集包含展示我的技术写作技巧和流程的原创内容。

作品集导航​

指南

API 参考

概念/概述文档

要查看这些文档的原始 Markdown 文件，请前往 GitHub。

文档工作流程​

  • 在 VS Code 中使用 Markdown 起草
  • 使用 Vale 进行 Markdown 格式检查
  • 使用 DeepL 进行翻译
  • 使用 Mermaid 创建图表
  • 使用 Git 进行文档版本控制
  • 使用 Postman 和 Swagger/OpenAPI 进行 API 验证
  • 使用 Docusaurus 发布

技术栈​

  • Docusaurus: 用于生成静态网站和文档。
  • VS Code: 所有内容的主要编辑器。
  • Postman: 用于 API 测试 and 生成 API 文档示例。
  • Vale: 用于格式检查并确保符合风格指南。
  • Git/GitHub: 用于版本控制和托管。
  • Mermaid Chart: 将 Mermaid 代码转换为图像。
  • DeepL MCP: 用于将文档翻译成多种语言。

这反映了专业团队维护开发人员文档门户（如 Docusaurus 或类似的静态网站生成器）的方式。

每一件作品都展示了端到端的文档创建过程：研究 → 起草 → 评审 → 发布。