【共建邀请】🚀RuyiSDK文档焕新计划：我们需要你的智慧与建议！

RuyiSDK
1

:heart:各位技术社区的朋友们，大家好！

首先感谢您对RuyiSDK的关注与支持！:folded_hands:

随着RuyiSDK的发展，我们意识到当前的文档主要面向 「具有技术背景的开发者」 ，在可读性和易用性上存在不足。为了更好地服务更广泛的开发者群体，我们决定将目标用户调整为 「新手友好型」 ，并对文档进行全面优化升级。

现在我们正式启动「RuyiSDK文档焕新计划」，诚挚邀请社区各位伙伴参与其中，提出宝贵意见，共同打造更优质的文档体验！:flexed_biceps:

:page_facing_up: 文档现状：Hello Ruyi | RuyiSDK
:package: 源码仓库： GitHub - ruyisdk/docs: Documents for RUYISDK

:one: 此次焕新计划的目标是什么？
将对现有的技术文档进行全面优化，使其清晰易懂、上手简单，即使是非专业开发者也能够轻松看懂并使用。

:two: 我们计划做什么？
• 将文档结构进行设计与重组，使其逻辑更清晰
• 将现有的专业技术文档，转化为通俗易懂的语言
• 编写 step-by-step 的新手教程和示例
• 收集和整理用户反馈，持续优化文档内容

:three: 我们希望给与的帮助有：
• 用你的同理心，帮助我们化繁为简，让技术文档更易懂
• 用你的逻辑思维，协助我们重构更清晰的文档结构
• 用你的文字能力，让内容表达更加流畅细致
• 用你的技术背景，直接参与文档内容的贡献和完善

:sparkles:无论您是：

  • 有技术写作经验
  • 擅长用户体验优化
  • 想要参与开源项目
  • 或者 simply 曾经被糟糕的文档困扰过，想要帮助改进

:waving_hand:我们都欢迎您的参与！欢迎通过以下方式参与：

  1. 在本帖评论提出您发现的问题或具体修改建议
  2. 在项目仓库中提交Issue或PR
  3. 联系我们一起讨论优化方案
7 个赞
2

有个很小的问题：

安装ruyi包管理器的这一节中给下载的二进制添加执行权限希望可以从““下面以 x86_64 架构为例” 换成“下面以 riscv64 架构为例”，或者加上其他架构的命令描述。

虽然这几个环境下的命令基本一样，但新手可能会比较迷糊，
经验老手：这一步是添加执行权限，噢我这个架构用xx命令就可以了
新手视角：照着文档一步步做，突然没有我这个架构的命令介绍了

2 个赞
3

:joy: :+1:
顺带说句，你头像上的眼睛也很漂亮。

1 个赞
5

就可预见到不久的未来,小白无脑的复制粘贴,出事就开issues无脑开喷,说你项目不行.

1 个赞
6

可复现性强也是技术文档的一个标准，文档可复现性强考虑周全也不代表会无脑复制然后错了就怪项目吧。

主要是正常无脑复制后开喷的人始终是那一批人，不会因为文档更详细了新手友好了这类人就多起来了（

1 个赞
7

咦还可以跨帖子引用，学到了

1 个赞