-
文档版本：3.4
-
文档链接： CocosCreatorAPI
相比2.x的文档，搜API点击不跳转定位到API那里就算了，搜了告诉我没有，用起来真的难受，有时候只能去搜Class类自己去找，我真的觉得好奇怪啊，更新引擎为啥文档也要重构啊，老轮子用得不香吗？
不是第一次搜不出来，是他每次都要去服务端获取数据，在获取完成前都是搜不出来的
等你看到控制台打印获取完成的信息后就可以搜索了，如下图
这个新的文档体验极差，完全没有商业软件的水平，估计也没有配产品经理，就是交给一个程序员三下五除二的撸出来，能将就用就行
像ccc这种开源软件，现在还没有大规模盈利的手段，那就只能维持一个人数很少的团队来做，人手短缺是每天都会头疼的问题，文档烂就烂一点吧，引擎搞好就行
问题是文档这东西，为啥要跟着引擎也重构啊，这玩意借用一下以前的不行嘛，能比直接用新框架要快？作为开发者每次看文档还得打开发F12看一眼真是体验为0
其实也不用F12，等个几秒就行了，你想想人手都投入到引擎本身的优化里，我们作出的游戏体验更好了，那这个文档烂也是可以忍受的了
和U3d比较确实有点差了。就是专门招一个人做文档。也不至于这么差。中英混合的说明。真是够恶心的
我还是不能理解，给个建议就是，在获取到数据之后加个回调，将搜索的内容重新显示出来我都不会觉得很难用。我觉得这不难吧，花很多时间和人手投入也算不上吧。
cocos每次升级大版本，API都要更改命名和调用方式，文档体验不好必定会影响开发体验。
cocos文档体验差，内容不全已经是十几年的老问题了。十多年引擎越来越好，API文档怎么说呢？文档体验不忘初心吧。
引擎升级了
开发者都要学习新的引擎，文档是一手教程
为什么论坛里面很多人提各种问题？不就是文档没有写好，一些简单的问题也没有办法找到官方的解释说明，只好到论坛里面各种骂娘了。
现在的API文档，起码的参数说明都不详细 各种class的跳转都没有 对比隔壁竞品的，真不是一般的差 简直就是敷衍！！！
1赞
官方：已经在改进了，下个版本更新
每次都要开网页翻译 
文档我都懒得搜（几乎等于没有），查接口，还不如去看引擎提供的源代码
我是先看d.ts，没有再去看源码，文档上面的都和d.ts一样，查也没有必要
我以为是我机子问题，所以今天花了几千块换了主板cpu和大内存，但是就目前cc的质量，说实话，我觉得距离收费标准至少还有6年到8年
感谢大家的反馈，API 文档这块确实整得很差，完全不像是一个商业引擎该有的水准。很多时候我们也不希望老是改，但是工作流改变了原来的东西没法用了，不然谁吃饱了撑着老是换是吧？
目前 3.4 的 API 文档是从引擎的 TS 源码自动解析出来的，本身引擎的模块结构其实不能直接满足文档的需求，我们花了不少精力去调整。目前投入了半个前端，还有对应的 UI 设计，我们也在调研后端的搜索引擎方案，会逐个版本优化上去。这事本身其实是占用编辑器产品团队的时间精力的，编辑器自身还有很多地方等着完善呢，所以文档系统的优先级没办法提得很高。
如果大家知道业界有什么更好的技术方案，让我们可以不用造这些轮子，也欢迎向我们安利！
我相信没人愿意吐槽，实在是接受不了这些卡卡卡的bug才吐槽的，我也已经不想再继续吐槽下去，只能静观其变，用论坛的一句话表达就是:等
我觉得 除了用TS生成API的工具的探索外，关于文档的内容部分，官方可以在论坛上招募一个公益的文档小组，来辅助官方的文档补全工作，还是有很多大佬愿意用爱发电的。开源项目参与进来不是坏事，哪怕只是写写补充文档。 我看目前论坛上就有很多人在做这样的事情，比如补全d.ts。 比如cocos creator插件的一些API补充说明，骨骼动画换装的方案总结。其实都实现成的，就是官方都没有收录罢了。
2赞
第一步：成立文档审核委员会（以下简称委员会），由官方人员和权威人士组成。负责分发任务和审核文档。
第二步：论坛招募文档小组，达到官方的文档小组标准（对引擎的了解程度为标准）
第三步：委员会发布相关文档需求，文档小组成员可以自由认领任务（每人同时认领上限为2个任务），任务完成提交委员会审核。
第四步：文档小组成员，可以直接投稿，修改或补充现有的文档。委员会审核后可加入。
1赞
要是啥时候api文档也能用gitbook重构就好了 现在那个api文档说实话我点开看不懂就直接退了 还不如看用户手册
已反馈意见给布道团队。目前如果有个人开发者要参与文档都是可以直接提交 PR 的，文档开源在 https://github.com/cocos-creator/creator-docs
如果是 API 文档的内容，目前都是从引擎源码直接解析生成的，大家想要参与维护也可以提交 PR 到引擎仓库
https://github.com/cocos-creator/engine