论坛 › ＰＣ数码 › 鸿蒙的文档真是太有趣了

燕山雪 发表于 2021-6-3 11:12

鸿蒙的文档真是太有趣了

本帖最后由 燕山雪 于 2021-6-3 11:21 编辑

心情不好只想摸鱼，于是到gitee上看传说中的鸿蒙代码，习惯性的从quick start文档https://gitee.com/openharmony/do ... ice-dev/quick-start开始，目录是这个画风：

数了数光quickstart就30多个md文件……再翻其他目录也大差不差，里面一部分文件长这样（截图都是全文，不是文件片段）：



我猜菊花内部是按上传文件数算KPI来着
另一部分是这样的：

总之跟我熟悉的开源框架文档不是一个画风啦，然而回头想想，自己也有啥都不懂没话可写还必须要编点啥完成任务的时候，五十步笑百步而已。所以决定还是少judge别人，安心搬砖提升自己去了，以上～

拯救节操希灵宅 发表于 2021-6-3 11:26

这感觉是嵌入式工程师的文档风格

台球论坛网友 发表于 2021-6-3 11:27

伊森温特斯 发表于 2021-6-3 11:37

lucky117 发表于 2021-6-3 11:38

去NGA发啊

rbf1993 发表于 2021-6-3 11:39

红都剧院24排4号 发表于 2021-6-3 11:39

ryanz 发表于 2021-6-3 11:42

rt-thread也是一样的风格，总要先教人怎么烧录嘛。正常情况下，这些东西应该在开发板的文档里面，然后开发板应该另起一个项目的。应该是开发板适配系统，而不是系统适配开发板，然后系统只有基本的编译说明。

燕山雪 发表于 2021-6-3 11:58

ryanz 发表于 2021-6-3 11:42
rt-thread也是一样的风格，总要先教人怎么烧录嘛。正常情况下，这些东西应该在开发板的文档里面，然后开发 ...

叫人烧录那篇虽然很嵌入式，但那已经是我看到的最像文档的文档了，其他像驱动内核之类目录里充斥的全是《Linux内核概述》这样的玩意……

llions 发表于 2021-6-3 12:19

写文档最烦的就是概述，引言，背景，目的，范围这些

ryanz 发表于 2021-6-3 13:06

燕山雪 发表于 2021-6-3 11:58
叫人烧录那篇虽然很嵌入式，但那已经是我看到的最像文档的文档了，其他像驱动内核之类目录里充斥的全是《 ...

这样的话，还是挺让人抓狂的。之前给一个币整fpga，然后那个币的github的文档都是什么去中心化，共识算法什么的，我要的算法遍历那一块死活找不到说明 =。=

sbzhang 发表于 2021-6-3 13:11

去lga分分钟被花粉冲爆

qieyifonger 发表于 2021-6-3 13:13

大型Ctrl-H文档项目，懂的都懂，哈哈~

mono 发表于 2021-6-3 13:19

你是不是境外势力

7七麦 发表于 2021-6-3 13:41

Litccc 发表于 2021-6-3 13:42

看了眼NGA，吓尿了

CyanCloverFern 发表于 2021-6-3 13:48

Litccc 发表于 2021-6-3 13:42
看了眼NGA，吓尿了

有传送门吗？

YoumuChan 发表于 2021-6-3 13:50

对比了一下Drone, Redox和TockOS的文档
感觉缺了一个带目录结构支持翻页搜索的文档网站
目前这个靠md互相链接，不知道下一个md是啥，每次只能回到父节点确实体验极差

OedoSoldier 发表于 2021-6-3 13:53

YoumuChan 发表于 2021-6-3 13:57

OedoSoldier 发表于 2021-6-3 13:53
不是有吗？

https://gitee.com/openharmony/docs/blob/master/zh-cn/device-dev/quick-start/Readme-CN. ...

以第二个链接为例，点进GPIO概述以后，需要先返回，再点进GPIO使用指导。
有两个缺点，一，看完GPIO概述以后，有可能已经忘了目录结构了，二，不能直接从GPIO概述下一页到GPIO使用指导

OedoSoldier 发表于 2021-6-3 13:59

YoumuChan 发表于 2021-6-3 14:01

OedoSoldier 发表于 2021-6-3 13:59
确实

其实解决起来也简单，直接上个CI，在仓库里跑个GitBook或者mdBook就好了。

walfeds 发表于 2021-6-3 14:07

你发这个什么目的.jpg

—— 来自 blackshark SKW-A0, Android 10上的 S1Next-鹅版 v2.4.4

u96 发表于 2021-6-3 15:15

泥潭也开始同温层了，这个贴跟鸿蒙那贴见到的id都不怎么重合。

7七麦 发表于 2021-6-3 15:24

裼黌諡綤罽龘 发表于 2021-6-3 15:27

7七麦 发表于 2021-6-3 15:29

燕山雪 发表于 2021-6-3 15:30

u96 发表于 2021-6-3 15:15
泥潭也开始同温层了，这个贴跟鸿蒙那贴见到的id都不怎么重合。

主要原因大概是非码农多半看不明白主贴槽点在哪

FerMonster 发表于 2021-6-3 15:32

Litccc 发表于 2021-6-3 13:42
看了眼NGA，吓尿了
nga里面到底是什么群体我很费解，作为一个魔兽论坛按理说都是成年人了。
但是IT区全是zz言论

anicorn 发表于 2021-6-3 15:38

FerMonster 发表于 2021-6-3 15:32
nga里面到底是什么群体我很费解，作为一个魔兽论坛按理说都是成年人了。
但是IT区全是zz言论 ...

别说NGA了，虎扑知乎泥潭也差不多一个样子。
有些根本不是过来想跟你讨论问题的，就是抓着这个旗子打你耳光而已。

FerMonster 发表于 2021-6-3 15:45

anicorn 发表于 2021-6-3 15:38
别说NGA了，虎扑知乎泥潭也差不多一个样子。
有些根本不是过来想跟你讨论问题的，就是抓着这个旗子打你耳 ...

我之前论坛接触不多，贴吧的战斗力就不多说了，没有那么多理由，就是单纯的对骂
虎扑就是男性微博，各自站队球星然后护主，IT区继承了这个特征。并且加上nga感觉都是hw大本营

Litccc 发表于 2021-6-3 15:45

CyanCloverFern 发表于 2021-6-3 13:48
有传送门吗？

IT区主页就有好几帖

Nanachi 发表于 2021-6-3 15:47

就在git里通过md格式管理文档，太糙了，而且这样没全文搜索功能吧。

虽说我整的s1帖子存档repo也是这样难看就是了

—— 来自 OnePlus KB2000, Android 11上的 S1Next-鹅版 v2.4.4.1

重巡羊舰 发表于 2021-6-3 15:52

没懂，这贴怎么了，为啥要扣分？

jpcl 发表于 2021-6-3 15:56

伊森温特斯 发表于 2021-6-3 15:58

董卓 发表于 2021-6-3 16:01

我司甲方，华为乙方
作为利益相关人员表示
华为驻场挺辛苦，现写实施文档挺常态

u96 发表于 2021-6-3 16:20

燕山雪 发表于 2021-6-3 15:30
主要原因大概是非码农多半看不明白主贴槽点在哪

我不信这楼里全是码农。

u96 发表于 2021-6-3 16:20

本帖最后由 u96 于 2021-6-3 16:21 编辑

燕山雪 发表于 2021-6-3 15:30
主要原因大概是非码农多半看不明白主贴槽点在哪

风怒。

u96 发表于 2021-6-3 16:20

燕山雪 发表于 2021-6-3 15:30
主要原因大概是非码农多半看不明白主贴槽点在哪

风怒。

查看完整版本: 鸿蒙的文档真是太有趣了