Repository navigation
Replies: 2 comments
|
文档这个确实是个老问题了,插件的接口太多太庞大了,我来负责这个的优化,提供完整的可直接上手开发的详细文档 |
0 replies
|
已提交完整开发文档 |
0 replies
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Uh oh!
There was an error while loading. Please reload this page.
我想提出的问题如标题所述。但是我想多嘴几句:我非常能够理解开发者拿出了大量精力去开发软件,所以几乎没有精力去编写文档。就算是我有精力的时候,我也经常懒得写文档,转而让 AI 帮我写。那用户文档我好像也没看过多少回,但是开发文档是不是该稍微认真点?
还是那句话,我非常能够理解你拿出了大量精力开发软件,所以几乎没有精力编写文档。但是,首先,
plugin-tutorial/zh/index.md中提到:但是后面却用了整整三个章节去讲解 JavaScript 基础,这似乎有些本末倒置了。我当然也理解这是 AI 的问题,但是让 AI 写文档的话,是不是自己也可以看一看?先不说“不重要的事情 AI 可能会写的很详细”,就比如说刚才所说的“明明读者是有编程基础的,却依旧拿出大量篇幅讲解JavaScript基础”这个问题,咱至少不要本末倒置啊。本来一个根本东西,重要的东西你至少得写出来啊。这一篇文档就像一棵树一样,你可以去额外再多嘴几句基础的,万一这个人只是有编程基础,但是没有 JavaScript 的基础呢?那你让这棵树顶上长得很茂盛是可以的。但是你不能把根本丢了啊、你不能连宿主应用提供了哪些 API 都不写啊,你连它提供了哪些 API 都不写,我看完文档,我从会 JavaScript 的人变成了会 JavaScript 的人,但是我不知道它提供了哪些 API,那我怎么写呢?就像我们给 Agent 提供工具,让 Agent 帮我们干活一样,我们提供工具是为了让 Agent 帮我们干活,如果我们不提供工具,那 Agent 就没办法帮我们干活。文档也是如此,如果我没有 API(文档没讲),那我根本不知道从何下手。
All reactions