writer-mcp-server

This MCP server serves as a copilot for a technical writer. The general thinking pattern for a technical writer is as follows:

General thinking pattern of technical writers

Step 1. Analyze the documentation requirement

The technical writer receives a documentation requirement from the product manager or other stakeholders. The technical writer needs to research the documentation requirement. The research may be conducted by:

• Reading existing documentation. Existing documentation of the following products:
  • 火山引擎内容分发网络（CDN）：https://www.volcengine.com/docs/6454/71358
  • 火山引擎全站加速（DCDN）：https://www.volcengine.com/docs/6559/79753
  • 火山引擎全球加速（GA）：https://www.volcengine.com/docs/6737/159218
  • 火山引擎应用型负载均衡（ALB）：https://www.volcengine.com/docs/6767
  • 火山引擎边缘计算节点：https://www.volcengine.com/docs/6499/74590
  • 火山引擎 TrafficRoute DNS 套件：https://www.volcengine.com/docs/6758/66326
  • 火山引擎证书中心：https://www.volcengine.com/docs/6638/93503
  • 火山引擎域名服务：https://www.volcengine.com/docs/6568/128970
  • 火山引擎多云 CDN（MCDN）：https://www.volcengine.com/docs/6766
  • 火山引擎边缘智能：https://www.volcengine.com/docs/6893/153487
  • 火山引擎大模型网关：https://www.volcengine.com/docs/6893/1263413
  • 火山引擎物联网平台：https://www.volcengine.com/docs/6893/1514452
  • BytePlus CDN：https://docs.byteplus.com/en/docs/byteplus-cdn/learning_path_console_en
  • BytePlus DNS Suite：https://docs.byteplus.com/en/docs/byteplus-dns-suite/docs-product-overview
  • BytePlus Certificate Center：https://docs.byteplus.com/en/docs/byteplus-certificate-center/docs-what-is-byteplus-certificate-center
  • BytePlus Application Load Balancer：https://docs.byteplus.com/en/docs/alb/Introduction
• Conducting research on the internet
• Reading design docs of the feature, such as PRD or technical specs
• Interviewing with SMEs, such as product managers and engineers
• Trying the new feature in the place of a user

Step 2. Create a documentation plan

The documentation plan may be categorized into:

• Documenting a new feature:
  • Provide conceptual, procedural and referential content for the new feature, such as overviews, user guides or API references
  • The writer needs to evaluate the impact of the new feature on other documentation and perform changes to the existing documentation
• Update documentation for an existing feature that went through an iteration

Step 3. Create documentation draft

The writer needs to create the documentation draft according to the documentation plan. The documentation draft has the following structure:

| 使用阶段 | 手册 | 内容定义 | 示例| | --- | --- | --- |--- | | 了解与规划 | 产品动态 | 让用户了解产品的新功能和相关公告，相当于一个简版的 release notes。 | https://www.volcengine.com/docs/6396/67700 | | 了解与规划 | 产品简介 | 介绍产品是什么、产品架构、产品优势、产品功能、使用场景、成功案例等，让用户快速了解产品的核心能力和使用场景。 | https://www.volcengine.com/docs/6396/67702 | | 了解与规划 | 产品计费| 提供产品计费方式相关说明，帮助用户了解产品预算。 | https://www.volcengine.com/docs/6396/69812 | | 操作 | 快速入门 | 通过简单使用场景说明了产品的使用流程 | https://www.volcengine.com/docs/6396/1133968 | | 操作 | 用户指南 | 详细说明了产品的使用流程、各功能节点操作步骤说明 | https://www.volcengine.com/docs/6396/67751 | | 操作 | 最佳实践 | 提供产品或产品功能使用的最佳方法，帮助客户节省成本或提升性能等| https://www.volcengine.com/docs/6396/130739 | | 二次开发 | 开发指南 | 本产品的二次开发方式与集成接入方案 | | | 二次开发 | API 参考 | 提供本产品/解决方案的 OpenAPI 及调用方式，参数说明和DEMO | https://www.volcengine.com/docs/6396/1053194 | | 二次开发 | SDK 参考| 提供本产品/解决方案的SDK下载地址和使用说明 | https://www.volcengine.com/docs/6396/114179 | | 其他 | 常见问题 | 提供产品使用过程中可能遇到的常见问题以及解决方案 | https://www.volcengine.com/docs/6396/67770| | 其他 | 相关协议 | 产品特有的相关协议，必须和法务团队确认。 | |

Step 4. Review the documentation draft

The writer needs to ask SMEs for their feedback on the documentation draft. The feedback may include:

• Accuracy of the content
• Consistency with the product direction
• Clarity of the content
• Completeness of the content

The writer needs to make changes to the documentation draft based on the feedback.

Step 5. Publish the documentation

The writer needs to publish the documentation draft to the documentation platform.

MCP server as a copilot of a technical writer

As a copilot of a technical writer, the MCP server can use the thinking pattern to help technical writers in their work and actively prompt the writer for input and feedback.