华为云CCE产品文档优化升级

最新推荐文章于 2024-04-26 16:10:55 发布

容器魔方

最新推荐文章于 2024-04-26 16:10:55 发布

阅读量46

点赞数

文章标签：华为云云原生容器微服务

本文链接：https://blog.csdn.net/2301_80396997/article/details/134113319

版权

云原生产品技术栈庞大，需要用户对容器、Kubernetes等核心技术都有扎实的理解和掌握；同时问题定位和排查也较为困难，需要用户对不同系统模块原理非常熟悉。这些因素导致云原生产品上手门槛高、配置和运维复杂。

为此，华为云云容器引擎CCE产品团队在CCE文档方面进行了重点优化，以降低用户的使用难度：

1. 优化文档结构，以便用户更系统地获取所需信息;

2. 新增大量实操内容，提供了配置参考，丰富了最佳实践；

3. 对已有文档内容进行重构与升级，更新了关键操作指导，确保内容更加易用；

4. 新增高质量问答对，实现智能化问答。

通过文档服务的全面提升，用户可以更轻松地上手和使用云原生产品，大幅降低难度。

▎结构优化：知识体系完善,学习路径清晰

为了帮助用户更直观地获取所需信息，在内容结构上，我们针对用户学习和检索行为对文档目录进行了优化，使用户能够更加清晰了解CCE的学习使用路径。用户可以轻松地跟随这条路径，从入门级别的基础操作指导开始，逐步深入到更高级的管理和运维实践。这种渐进式学习路径帮助用户建立坚实的基础，从而更好地理解和掌握云原生技术。

图1 文档目录优化

其次，我们加强了文档之间的关联性。每篇文档都与其他相关文档形成了链接，帮助用户在需要的时候能够轻松地跳转到相关主题。确保用户可以更全面地了解整个云原生技术生态系统。

图2 文档关联性增强

▎内容上新：实操案例丰富,满足用户需求

CCE文档的内容优化是为了让用户能够在使用CCE时轻松获取所需信息，配置系统并应对各种关键场景。

首先，我们引入了一份详尽的CCE配置参考手册，其中列出了各类参数的详细说明，包括集群、节点等各项配置。用户可以在配置手册中找到所需的参数信息，从而更好地理解和掌握系统配置。

图3 配置手册

此外，我们还新增多篇CCE最佳实践，覆盖了一系列关键场景，如基于容器的CI/CD、应用上云、日志监控等，旨在帮助用户在实际应用中成功地配置和管理云原生环境。用户可以依照这些最佳实践，快速了解如何部署容器应用、将服务迁移到云端以及如何设置有效的日志监控系统。这些实际场景的指导有助于用户将理论知识转化为实际操作，提高技能水平，同时减少配置和部署的复杂性。

图4 最佳实践

▎内容重构升级：核心知识更可靠,操作更明确

对文档内容进行了重构与升级，更新了关键操作指导，确保内容更加易用。

例如我们对容器存储相关文档进行了全面的重构，容器存储是云原生环境中不可或缺的一部分，因为它涉及到应用程序数据的持久性和可靠性。我们重新审视并更新了存储文档，确保其内容涵盖了各种存储解决方案和最佳实践，并将内容从以K8s对象角度更新为存储类型角度组织，使得用户能够更加直观的从使用存储的角度查找并使用文档。

图5 存储内容重构升级

▎智能问答增强：用户体验更友好,问题快速解答

在CCE文档的智能问答部分，我们新增了超过800条高质量问答对，旨在全面覆盖CCE的常见问题和疑虑。这意味着用户现在可以像与客服交互一样，通过智能问答系统获得即时反馈，无需漫长的搜索或等待。

这项改进的好处不仅仅在于提供更快速的解答，还在于增强了文档的互动性和友好度。用户不再需要翻阅大量文档或手动搜索答案，而是可以直接向智能问答系统提问。这种自然语言查询的方式使文档更加与用户互动，打破了传统文档的单向性质。用户可以随时提出问题，获得立即的、个性化的答案，从而提高了文档的实用性和用户体验。