作者：慕扉

用户在依据文档进行操作时，会出现依据文档内容建立环境困难、代码调试失败、功用无法运用的情况，主要是由于文档中有年久失修、没人保护、无法跑通的代码，给用户快速上手带来很多的应战。

为了处理文档中的这些用户体会问题，经过函数核算的才能让阿里云的文档从静态展现晋级为动态可操作验证，用户在文档中单击一键布置可快速完结代码的布置及测验。这一改动已在函数核算的活动沙龙中得到用户的认可，你也快来体会一下吧~~

用户问题及痛点

阿里云的产品作为技术驱动型处理方案，用户对文档中供给的代码示例有较高的依靠。经过分析，发现用户在运用文档时有以下问题。

文档中供给的代码过错，用户无法直接运用

运用如下的代码示例，在测验时一直报错，导致用户无法直接运用。 文档中的代码示例由于长时间未更新和缺乏保护，已经变得过时，这直接影响用户运用文档时的体会。

代码示例：
让你的文档从静态展现到一键布置可操作验证
 报错信息：
让你的文档从静态展现到一键布置可操作验证

文档中只供给代码片段，用户调试门槛高

文档中只供给代码片段，缺乏完好的项目结构和环境装备攻略，用户需求自己建立项目和设置运行环境， 才能运用文档中介绍的功用，这无疑增加了用户实践操作的难度，甚至会吓退很多新手用户。

让你的文档从静态展现到一键布置可操作验证

文档中没有供给代码，用户无法参阅文档运用该功用

例如：函数核算的装备 OSS 文件体系文档中，只供给给用户如何装备 OSS 挂载，却没有供给如何拜访 OSS 挂载文件相应的代码示例， 这直接导致用户想运用该功用时参阅该文档无法获取想要的信息。

原文档内容：
让你的文档从静态展现到一键布置可操作验证
 用户期待的文档内容：
让你的文档从静态展现到一键布置可操作验证

处理方案：供给动态可操作验证的文档

函数核算是一种 Serverless 架构形式，专注于事情驱动的函数编程，供给端到端的处理方案。用户运用函数核算，不需求收购与办理服务器等基础设施，只需编写并上传代码或镜像。一起函数核算支撑多种编程言语，函数创立完结后能够快速调试验证。

假如文档中的代码能够布置在函数核算平台，那么用户能够在文档中直接操作验证代码供给的功用， 会直接进步用户运用文档代码的体会。

完成方案

整个处理方案的流程示意图如下所示。

让你的文档从静态展现到一键布置可操作验证

  1. 经过 Serverless Devs 东西开发并发布完好代码对应的运用模板。
  2. 在文档中装备一键布置，将代码片段与运用模板关联，并发布文档。
  3. 用户在文档中单击一键布置后，依据运用名称在函数核算布置运用，并能够直接测验代码功用。

文档作用

以运用函数核算布置通义千问大模型完成 AI 对话文档为例，介绍文档动态可操作的作用。

用户能够在文档中运用一键布置的进口

1）文档最上方

让你的文档从静态展现到一键布置可操作验证

2）支撑一键布置的代码片段前面，重点提醒用户可点击。支撑一键布置的代码 codeblock 右上角

让你的文档从静态展现到一键布置可操作验证

单击一键布置后

单击一键布置后，会依据装备的运用模板将代码需求注册的服务、角色、装备的参数在面板中出现，用户需注册及装备。

让你的文档从静态展现到一键布置可操作验证

布置并检查运用

  1. 运用布置成功后，能够检查运用的基本情况。
  2. 单击操作列的测验，即可进入函数核算供给的测验页面。
  3. 在测验页面，已默许将测验参数填入，单击测验函数，即可依据参数进行函数调用。
  4. 最终会返回函数调用返回结果。

用户反应

在 2023 年 12 月的函数核算活动沙龙中，有 70 多名用户体会了该文档的一键布置才能。在 2024 年 1 月的活动沙龙中，有 2000 多名用户参加使命的体会，其中有 500 用户完结。用户反应从文档直接布置下降了体会该功用的门槛。

让你的文档从静态展现到一键布置可操作验证

总结

文档中增加一键布置后有以下优势：

1）用户文档运用体会进步

本来用户在文档中看到的是文字说明及代码片段，要自己建立环境，构造完好的项目代码运用该功用，耗时不只长且简单出错，关于新手用户不友好。 现在用户能够直接单击一键布置即能够快速体会该功用，不只进步操作功率，还能够下降运用过程中的过错率。

2）快速验证代码的正确性

本来文档中供给代码，需求用户单独构建项目环境验证保证代码正确性，全体本钱高。 现在文档中的代码已关联完好的可运行代码，能够快速布置验证代码正确性，下降代码验证的本钱。

3）快速获取完好代码

本来文档中的代码大部分是研制供给的代码片段，并未供给完好的代码，导致代码片段和可完好运行的代码分裂，用户无法快速从文档获取完好的代码。 现在文档中的代码统一在 GitHub 库房保护，文档中出现代码片段，每次变更可找到源码修正，用户能够经过文档操作获取到完好代码。

最后

好的文档应当超越文字的边界，成为常识传递和技能培育的桥梁。阿里云函数核算让咱们朝着这一目标迈出了重要一步。咱们将文档从传统的静态页面晋级为一个动态的、互动性强的东西，用户能够经过一键布置直接在函数核算平台验证文档内容。这种改变较大地进步了文档的可操作性和实践运用价值，让用户不只是阅览和理解概念，还能经过实践操作运用该才能。

咱们诚邀一切用户来体会函数核算文档从静态到动态的改变，希望经过你们的参加和反应，不断优化文档，助力每位用户在学习和运用文档的过程中完成最大化的收益。

假如您希望体会文档的一键布置才能，能够拜访下面文档链接。