北京 b 开头某大厂边缘部门你们能好好写文档吗

2022-05-14 21:54:05 +08:00
 3kkkk
接口文档不写请求类型,类型是 array 描述给的是 hash 示例,傻傻区分不清。接口外层标注一些情况为空,内部又标注部分字段为空。还没有示例。真是醉了对得起你们的工资吗?写个文档到处模棱两可。
4463 次点击
所在节点    程序员
23 条回复
Axnir
2022-05-14 21:56:25 +08:00
baidu 还是 bytedance 呢
lisongeee
2022-05-14 22:01:24 +08:00
byd ?
fengjianxinghun
2022-05-14 22:08:34 +08:00
```类型是 array 描述给的是 hash 示例```
是不是 php 写的?
3kkkk
2022-05-14 22:18:52 +08:00
@fengjianxinghun 👍👍👍我去看了下 php 语法还真是这样。应该是 php 写的。
learningman
2022-05-14 22:24:17 +08:00
gam2046
2022-05-14 22:37:26 +08:00
文档这个吧,我发现多数大厂的文档还不如一些开源项目。国内商业公司,我接触过文档写的最好的是支付宝,其他就都那样了,至于比烂呢,大概就是微信了,这个体量和这个文档质量,一言难尽。

国外拿得出手的是微软,其次是 Google 的一些热门项目( Android 一类),相对不那么热门的项目文档已经很鸡毛了。

但是我自己也作为开发人员,写文档,特别是针对用户的文档,写起来比写代码还费时间。而且随着产品迭代,很容易忽略文档的更新。
mysunshinedreams
2022-05-14 23:04:32 +08:00
最奇葩的是,某大厂开发前追着你要接口文档,开发的时候根本不按接口文档开发。
panlatent
2022-05-14 23:39:06 +08:00
PHP 只有一个数据结构就是 array ,不经转换直接输出的话就输出各式各样的东西,比如说数组、对象( HASH/map/字典) ,值的类型也可能会变 比如 字符串数字和整数, 有时 null 还会夹杂其中。

好点的做法是做一层输出转换,有些 php 库专门干这个,但最好的方法还是限制住类型。
3kkkk
2022-05-15 00:26:57 +08:00
返参业务数据日期直接 string,描述也不写格式,鬼才能解的开。
ufan0
2022-05-15 01:05:30 +08:00
杭州某大厂,其重量商业级产品文档都是错的,比如 yuque 、SofaBoot Stack ,提 Issue 后回复我让我自己贡献 PR ,如果是错别字什么的我就提交了,但是那是缺少内容甚至是内容错误啊,就离谱。
panlatent
2022-05-15 01:33:26 +08:00
@3kkkk 日期格式除了时间戳之外不就是字符串了么? 字符串的话只要是标准我还都能接受,有一些可能没加市区,一般默认北京时间,但是见过不少本身业务带时区的不加或者与 0 时区转换出的 bug
LxExExl
2022-05-15 03:30:35 +08:00
直接说公司名会被查水表吗?

为啥要某某 abc 开头这么说呢?
28Sv0ngQfIE7Yloe
2022-05-15 04:01:06 +08:00
微信的文档更操蛋
coolmenu
2022-05-15 06:31:37 +08:00
@mysunshinedreams 要开发文档是他们拖延工作的一部分,开发的时候,估计扔给外包或者新人小弟就不管了。
janxin
2022-05-15 08:53:28 +08:00
这是国内绝大部分大厂的通病
evilStart
2022-05-15 12:10:00 +08:00
百度就是百度,直接说出来会死?
难怪你们天天抱怨中文互联网搜不到有用信息。你们天天打谜语那能搜到吗?

我把标题重新复述三遍,方便别人搜索。
百度边缘部门的开发文档写的太烂!
百度边缘部门的开发文档写的太烂!
百度边缘部门的开发文档写的太烂!
Aloento
2022-05-15 19:23:49 +08:00
@evilStart 好开跟了
beordle
2022-05-15 21:37:32 +08:00
百度 PHP ! array! siza!
pigspy
2022-05-15 21:59:05 +08:00
为啥不直接说哪个公司的哪个部门呢?
czfy
2022-05-15 22:00:04 +08:00
谜语人滚出哥谭

这是一个专为移动设备优化的页面(即为了让你能够在 Google 搜索结果里秒开这个页面),如果你希望参与 V2EX 社区的讨论,你可以继续到 V2EX 上打开本讨论主题的完整版本。

https://www.v2ex.com/t/852860

V2EX 是创意工作者们的社区,是一个分享自己正在做的有趣事物、交流想法,可以遇见新朋友甚至新机会的地方。

V2EX is a community of developers, designers and creative people.

© 2021 V2EX