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

最近晒代码的“多隆奖”热火朝天。
不过对于刚入门的新手，做得最多的事情也许不是打代码，而是搭建各种环境、学习各种工具使用、尝试自己造“轮子”。作为新手有很多不懂的地方，容易犯一些哭笑不得的错误，也容易掉入各种坑。这时候一份良心的文档就非常重要了。
题主查看Google文档的时候，注意到底部有标明作者，也会默默为她点赞。

咱们阿里云也有很多良心的文档。题主也很想知道默默细心为阿里云一众新手写文档的小哥是谁呢！云栖社区的各位大神是否也贡献了文档呢？
如果你是一位学习多门编程语言、多个平台和多个工具的开发者，常年混迹于多个开源社区、开发者社区和博客网站，你可能会发现有不少平台和工具的文档还不够完善和易读。这可能是因为社区文档团队人手不足、时间仓促，也可能是写文档的大神没有想到新手哪里会不懂。
作为新手，你最喜欢什么样的文档？作为大神，你愿意为新手提供一份良心的文档吗？让我们一起来晒文档、写文档、改文档，为新手铺平进阶之路吧！
欢迎大家分享：
1、新手们晒晒最良心的文档。文档良心在哪里？带给你什么帮助？
2、开发者们列出存在不足甚至处于空白的文档。哪些文档需要补充和完善？
3、大神们来分享自己写的文档和教程吧！

参与话题

奖品区域 活动规则 1月后 结束

• 奖品一

  阿里云代金券 x 3

  

• 奖品二

  云栖帽衫 x 1

  

• 奖品三

  品牌U盘 x 1

  

10个回答                         按默认排序                         按时间排序                     

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 |序号

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

1

aoteman675 复制链接去分享

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

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

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

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

0

海阔天空yy复制链接去分享

1、新手们晒晒最良心的文档。文档良心在哪里？带给你什么帮助？
就拿接口接入来说会经历以下步骤:
了解接入流程>接口文档>下载api包>申请秘钥>添写信息>等待审核>动手在测试环境调试>正式平台调试>接口可以用了
最好是，在这个流程中所有环节上需要文档的地方都要有相文档，最好再有举例，这是最好的了。
拿淘宝的api举例吧

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

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