1. 聚能聊>
  2. 话题详情

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

最近晒代码的“多隆奖”热火朝天。
不过对于刚入门的新手,做得最多的事情也许不是打代码,而是搭建各种环境、学习各种工具使用、尝试自己造“轮子”。作为新手有很多不懂的地方,容易犯一些哭笑不得的错误,也容易掉入各种坑。这时候一份良心的文档就非常重要了。
题主查看Google文档的时候,注意到底部有标明作者,也会默默为她点赞。
Google_Chrome說明
咱们阿里云也有很多良心的文档。题主也很想知道默默细心为阿里云一众新手写文档的小哥是谁呢!云栖社区的各位大神是否也贡献了文档呢?
如果你是一位学习多门编程语言、多个平台和多个工具的开发者,常年混迹于多个开源社区、开发者社区和博客网站,你可能会发现有不少平台和工具的文档还不够完善和易读。这可能是因为社区文档团队人手不足、时间仓促,也可能是写文档的大神没有想到新手哪里会不懂。
作为新手,你最喜欢什么样的文档?作为大神,你愿意为新手提供一份良心的文档吗?让我们一起来晒文档、写文档、改文档,为新手铺平进阶之路吧!
欢迎大家分享:
1、新手们晒晒最良心的文档。文档良心在哪里?带给你什么帮助?
2、开发者们列出存在不足甚至处于空白的文档。哪些文档需要补充和完善?
3、大神们来分享自己写的文档和教程吧!

参与话题

奖品区域 活动规则 已 结束

  • 奖品一

    阿里云代金券 x 3

  • 奖品二

    云栖帽衫 x 1

  • 奖品三

    品牌U盘 x 1

23个回答

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

zijiejiang 已获得阿里云代金券 复制链接去分享

1、新手们晒晒最良心的文档。文档良心在哪里?带给你什么帮助?
优秀的产品必然需要配合优秀的文档才能更好的传播。咱们阿里云的各种文档质量都非常高,我都是把需要的文档打印成册,随时翻阅。
211663802
1555430080
借助文档,能切实提高开发效率,避免很多坑和折腾时间。
2、开发者们列出存在不足甚至处于空白的文档。哪些文档需要补充和完善?
有的文档真的是有点不接地气。比如百度的webuploader文档,对上传文件数量限制是这样的
__2018_05_18T07_30_55_170Z
然而事实上这里fileNumLimit是指单次选中文件的数量,不是上传文件总数。
3、大神们来分享自己写的文档和教程吧!
没有呢,呵呵。

0

浮生递归 已获得阿里云代金券 复制链接去分享

1、新手们晒晒最良心的文档。文档良心在哪里?带给你什么帮助?
看是怎么出来的吧,比如是工作安排,必须要写,那就无所谓良心。如果是主动编写的文档,当然就都是良心所在了啊。文档或多或少总能有些帮助,如果正好写到自己不会的点上,那真是帮助大了。可以说,一篇刚好能帮助我解决难题的文档,比如一个api调用的详细说明,我就愿意像简书的文章一样,为作者打赏现金而不仅仅只是点赞。

2、开发者们列出存在不足甚至处于空白的文档。哪些文档需要补充和完善?
还是说api调用吧,范例通常只有很少的几种常用主流语言,用户数稍微少一点的,就没有范例文档了。比如通常就是php c# java python完了。你让其他语言的新手情何以堪?我当初看到这些api调用范例的时候,也是很懵圈的。

3、大神们来分享自己写的文档和教程吧!
好久没写过教程了。只在20来年前,做过一些软件安装的教程。那时候用电脑的人少,上网的人更少。所以简单的软件安装都不会。像当时很流行的媒体播放器,比如realplay one,我就专门做了个安装演示的flash动画,方便给使用的人参考。访问量也是蛮大的。
还有ps效果的图文教程等等。

0

钟元大老爷 已获得云栖帽衫 复制链接去分享

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

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

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

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

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

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

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

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

bug

0

海阔天空yy 已获得品牌U盘 复制链接去分享

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

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

1

aoteman675 复制链接去分享

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

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

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

0

1065703381047513 复制链接去分享

全民编程

0

1602244890493988 复制链接去分享

希望阿里的文档不断完善,推陈出新,再出一些视频教程就更好了哈!

0

1740329348614635 复制链接去分享

很棒,值得拥有。

0

1712898439475241 复制链接去分享

数学有计算机哈哈😄

0

1712898439475241 复制链接去分享

我是文盲不懂英语不懂数学这个信息全是技术吗?我又懒得学这两门,可以找个人带替😊

0

1225002605118916 复制链接去分享

我觉得阿里的文档很良心啊

0

方啸谦 复制链接去分享

我是小白,请大家多多关照

0

31462666 复制链接去分享

创头条可以拼你一下哦

0

1740626827175458 复制链接去分享

高级的文档可以用知识库的方式存储.调用

0

1370225865443190 复制链接去分享

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

0

1807226316068850 复制链接去分享

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

0

aarontsao 复制链接去分享

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

-1

阿德明网络 复制链接去分享

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

0

骐源 复制链接去分享

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

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

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

2
3867
浏览
0
收藏
邀请他人互动
MySQL 是全球最受欢迎的开源数据库,阿里云MySQL版 通过深度的内核优化和独享实例提供稳定极致的数据库性能...

消息队列(Message Queue,简称MQ)是阿里云商用的专业消息中间件,是企业级互联网架构的核心产品,基于...

高速通道(ExpressConnect)是一款便捷高效的网络服务,用于在云上的不同网络环境间实现高速、稳定、安全...

为您提供简单高效、处理能力可弹性伸缩的计算服务,帮助您快速构建更稳定、安全的应用,提升运维效率,降低 IT 成本...