祭出你看过最良心的文档吧！

云栖小二
115 阅读8分钟
原文链接： click.aliyun.com
1

微wx笑

贴一段通过工具生成的，大家指点指点：

购置方式相关操作接口

分页查询购置方式列表接口
http://IP:Port/ProjectName/mobileapi/buyMode/findPage.do?token=9DB2FD6FDD2F116CD47CE6C48B3047EE
Method:GET
参数列表:
|参数名 |类型 |必需 |描述
|----- |---- |---- |----
|token |String |Y |令牌
|start |Integer |N |分页开始加载记录索引，从0开始
|limit |Integer |N |每页多少条数据
返回值：
|参数名 |类型 |描述
|total |Integer |总记录数
|rows |List<BuyMode> |结果实体对象列表
|colmodel |List<Column> |表结构列名列表


查询购置方式列表接口
http://IP:Port/ProjectName/mobileapi/buyMode/findList.do?token=9DB2FD6FDD2F116CD47CE6C48B3047EE
Method:GET
参数列表:
|参数名 |类型 |必需 |描述
|----- |---- |---- |----
|token |String |Y |令牌
返回值：
|参数名 |类型 |描述
|code |String |响应代码
|result |String |响应说明
|BuyModeList |List<BuyMode>|购置方式实体类列表


保存或更新购置方式信息接口
添加或修改购置方式信息接口
http://IP:Port/ProjectName/mobileapi/buyMode/save.do?token=9DB2FD6FDD2F116CD47CE6C48B3047EE
Method:POST
参数列表:
|参数名 |类型 |必需 |描述
|----- |---- |---- |----
|token |String |Y |令牌
|id |Long |Y |编号
|companyId |Long |N |公司编号;公司表
|modeName |String |N |购置方式
|orderId |Integer |N |序号
返回值：
|参数名 |类型 |描述
|code |String |响应代码
|result |String |响应说明
|BuyMode |Object |购置方式实体类


删除购置方式接口
http://IP:Port/ProjectName/mobileapi/buyMode/delete.do?ids=1234,12345&token=9DB2FD6FDD2F116CD47CE6C48B3047EE
Method:POST
参数列表:
|参数名 |类型 |必需 |描述
|----- |---- |---- |----
|token |String |Y |令牌
|ids |String |Y |购置方式编号,可以传一个或多个编号，编号之间用英文半角的逗号“,”分隔。
返回值：
|参数名 |类型 |描述
|code |String |响应代码
|result |String |响应说明


根据 ID 获取购置方式信息接口
http://IP:Port/ProjectName/mobileapi/buyMode/get.do?id=1&token=9DB2FD6FDD2F116CD47CE6C48B3047EE
Method:GET
参数列表:
|参数名 |类型 |必需 |描述
|----- |---- |---- |----
|token |String |Y |令牌
|id |Long |Y |购置方式编号
返回值：
|参数名 |类型 |描述
|code |String |响应代码
|result |String |响应说明
|BuyMode |Object |购置方式实体类
购置方式实体类字段说明
|id |Long |Y |编号
|companyId |Long |N |公司编号;公司表
|modeName |String |N |购置方式
|orderId |Integer |N |序号 发布时间：5小时前 0人评论
1

aoteman675

1、新手们晒晒最良心的文档。文档良心在哪里？带给你什么帮助？
阿里云帮助文档中心，几乎所有的产品文档都可以查得到，而且又有智能客服、云博士提问回答。但是有些文档能在视频中心多加一些视频文件，适合新手快速入门的那种。

2、开发者们列出存在不足甚至处于空白的文档。哪些文档需要补充和完善？
就是视频文档多一些，最好制作一个产品系列。

3、大神们来分享自己写的文档和教程吧！
暂时还没有这个技术水平

发布时间：20小时前 0人评论
0

钟元@ali

1 gitlab上的文档良莠不齐, 有的因为某个项目迭代速度太快，更新不及时

有的是因为文档随着业务的复杂度越来的冗余。作为工程师的我们不得不
花费大量精力来验证这个文档是否是可行的，或者通过钉钉来咨询负责这块的
同学解决。
阿里云的对外文档和ATA上的写的很好，大的量级的客户来review，敬畏心理， 大家说
好的才是真的好。

2 个人感觉文档应该是我们的好帮手而不是负担：

A 文档不是科研论文首先应该通俗易懂，目的是为了以后维护方便和传播。
有的文档一上来开始飙公式，写各种符号和抽象概念，的确证明自己的在学术和领域很
了不起。却不知道作为读者的我们只是想快速定位这个领域的具体问题到底是怎么解决，
而不是读完了，哦好高深，好像是那么回事，和没看过一样。花了时间没有解决我的问题
啊。

B 准确和可用，描述的问题一定是准确有效的，经过测试的，而不是直接贴上了一坨代码，
编译的时候根本就通不过，遇到问题找半天，没有相关的内容。

C 一定是严谨的。我们的同学写文档总是容易陷到惯性误区里， 觉得他懂得大家一定懂，
就是那么一回事，很简单，这个就不用写了。
结果导致工程方无法使用， 缺少环节， 步骤次序有问题。

一个文档的项目背景， 具体的应用场景， 解决问题的领域，文档修订版本， 项目的功能点，
不包含和没有覆盖的功能点。设计大于实现，没有文档约束，保证工程的质量就是笑话。

另外发现个bug， 我贴的普通文本， 解析成了pre.code , 快来认领一下。

bug

发布时间：15分钟前 0人评论
0

海阔天空yy

1、新手们晒晒最良心的文档。文档良心在哪里？带给你什么帮助？
就拿接口接入来说会经历以下步骤:
了解接入流程>接口文档>下载api包>申请秘钥>添写信息>等待审核>动手在测试环境调试>正式平台调试>接口可以用了
最好是，在这个流程中所有环节上需要文档的地方都要有相文档，最好再有举例，这是最好的了。
拿淘宝的api举例吧
image
我觉得像类似这样，带上例子的，就算比较良心了。
2、开发者们列出存在不足甚至处于空白的文档。哪些文档需要补充和完善？
我之前做过淘宝和微信的支付，就拿这个说吧
虽然只是做接口但要做的事还是挺多的：
了解接入流程>接口文档>下载api包>申请秘钥>添写信息>等待审核>动手在测试环境调试>正式平台调试>接口可以用了
我记得，要完成这个流程，不管是淘宝也好，微信也好，至少登录两处不同的地址？一个是用来看帮助的，一个是用来添写信息的
这个就不能叫用户一个入口全搞定吗?有的时候没经验的开发人员，往往看了api，却还要去找添写信息的帮助文档，找来找去的
最好是网站列个步骤，1,2,3,4,每一步骤怎么添，都有说明，最好不要叫用户已经在开发文档的网站上，遇到不明白的地方，却还要去百度了.

3、大神们来分享自己写的文档和教程吧！
我写的也不算好,就拿其中一个接口举例
image
还请大家给出建议

发布时间：4小时前 0人评论
0

1370225865443190

1、新手们晒晒最良心的文档。文档良心在哪里？带给你什么帮助？
答:用过一个大神开发的一个免费的文档，不用的时候可以变成悬浮窗，用的时候再使用完全免费
2、开发者们列出存在不足甚至处于空白的文档。哪些文档需要补充和完善？
答:我希望完善更多的功能以及用户的体验
3、大神们来分享自己写的文档和教程吧！
答:虽说学习过一些语言，但是文档还是没有制作过的，我会慢慢学习的

发布时间：5小时前 0人评论
0

1807226316068850

字都认识，词却一个也看不懂

发布时间：13小时前 0人评论
0

aarontsao

觉得每天阿里云有学不完的东西 就这样看啊看 雪啊雪。每天都很充实 每一天都是崭新的。

发布时间：17小时前 0人评论
0

阿德明网络

最讨厌你这种明明可以选10个礼品却只选5个打赏的聊主了[捂脸]

发布时间：20小时前 0人评论
0

骐源

1、新手们晒晒最良心的文档。文档良心在哪里？带给你什么帮助？
阿里云的帮助文档称得上良心。很详实很全面。

2、开发者们列出存在不足甚至处于空白的文档。哪些文档需要补充和完善？
亦有不足，有时产品文档太多让人无所适从无从下手。
视频教程多是介绍单一产品的，少有多产品综合的。比如云服务器、云数据库、负载均衡等如何配合使用？

3、大神们来分享自己写的文档和教程吧！
俺是小白，还是饶了俺吧。

发布时间：22小时前 0人评论
0

1115826369811201

有没有文本类的文档

发布时间：22小时前 0人评论
0

美福滔

好

发布时间：23小时前 0人评论
avatar
文章
阅读
粉丝