V2EX = way to explore
V2EX 是一个关于分享和探索的地方
现在注册
已注册用户请  登录
爱意满满的作品展示区。
huntzhan
V2EX  ›  分享创造

在筹备自己的开源项目文档,敬请不吝赐教!

  •  
  •   huntzhan ·
    huntzhan · 2022-11-02 00:37:19 +08:00 · 3292 次点击
    这是一个创建于 754 天前的主题,其中的信息可能已经有所发展或是发生改变。

    刚刚写完第一页《概述》,想了解一下大家读完的真实想法:

    https://the-vkit-x.feishu.cn/wiki/wikcnblgKy8YlUIqAL14WgfJQXe

    第 1 条附言  ·  2022-11-02 20:06:28 +08:00
    合并了大多数 GIF ,优化了图片,希望大家再试试看会不会卡
    第 2 条附言  ·  2022-11-05 13:59:51 +08:00
    经过大家反馈后,我最终弃用了飞书,转向使用 docusaurus + vercel 部署文档。
    见: https://v2ex.com/t/892785
    28 条回复    2022-11-07 21:43:10 +08:00
    PMR
        1
    PMR  
       2022-11-02 01:14:29 +08:00 via Android
    效果图适当就够

    License 写上
    huntzhan
        2
    huntzhan  
    OP
       2022-11-02 02:12:43 +08:00
    @PMR 感谢,License 加上了。效果图放得应该挺克制了,我还有很多😂
    wzw
        3
    wzw  
       2022-11-02 07:08:44 +08:00 via iPhone
    飞书有这个功能了?
    daiv
        4
    daiv  
       2022-11-02 07:29:46 +08:00
    @huntzhan #2 如何做到不要登录就能给 任何人查看的? [用来写产品文档挺好的, 还可以实时更新, 比 vuepress 方便]
    huntzhan
        5
    huntzhan  
    OP
       2022-11-02 07:32:20 +08:00
    @wzw 飞书知识库,我觉得很赞。原本是打算用 docusaurus 搭一个文档站点的,但调研发现飞书知识库已经能满足我的文档需求了,于是就不想折腾了😂。不过飞书知识库似乎不会被搜索引擎收纳,这是一个问题。
    huntzhan
        6
    huntzhan  
    OP
       2022-11-02 07:35:34 +08:00
    @daiv https://www.feishu.cn/hc/zh-CN/articles/328843312369
    注意,那个分享按钮被移动到了页面下方,在设置按钮的右边,我找了好久才找到,感觉挺反直觉的。
    pansongya
        7
    pansongya  
       2022-11-02 07:57:18 +08:00 via iPhone
    项目牛逼 希望可以有比较详细的使用说明 另外为啥用飞书 还要有登录限制
    huntzhan
        8
    huntzhan  
    OP
       2022-11-02 09:00:41 +08:00
    @pansongya

    > 希望可以有比较详细的使用说明
    在写了😂

    > 另外为啥用飞书 还要有登录限制
    有登陆限制吗?应该是不需要登陆就能访问的呀
    ZxBing0066
        9
    ZxBing0066  
       2022-11-02 09:02:28 +08:00
    飞书这。。也太卡了吧 😂
    TYTheKing
        10
    TYTheKing  
       2022-11-02 09:15:28 +08:00
    可恶,居然是小黑子[doge]
    nipao
        11
    nipao  
       2022-11-02 10:07:15 +08:00
    飞书文档,看上去很美好,其实用户打开的体验太差。
    利用 github 自己搭建的成本也不高,或者用 thoughts ,写作、浏览体验比飞书文档好太多
    939630029
        12
    939630029  
       2022-11-02 10:24:31 +08:00
    好像很厉害
    shawndev
        13
    shawndev  
       2022-11-02 13:17:50 +08:00
    logo 整挺好。
    huntzhan
        14
    huntzhan  
    OP
       2022-11-02 13:58:40 +08:00
    @ZxBing0066
    想要请教一下,“飞书太卡”具体是指的是 1) 页面从加载到看到文字的时间太长,还是指 2) 页面内元素(比图图片)加载时间太长,或是指 3) 其他方面的卡顿?

    我确实在这个页面里放了很多 GIF ,可能是一个问题。
    huntzhan
        15
    huntzhan  
    OP
       2022-11-02 13:59:36 +08:00
    @nipao 可以分享一下您觉得飞书“用户打开的体验太差”的方面吗?
    huntzhan
        16
    huntzhan  
    OP
       2022-11-02 14:07:24 +08:00
    @TYTheKing 🐔🏀
    huntzhan
        17
    huntzhan  
    OP
       2022-11-02 14:13:49 +08:00
    Thecosy
        18
    Thecosy  
       2022-11-02 18:59:39 +08:00
    可以,但是打开有点慢
    nasa
        19
    nasa  
       2022-11-02 20:01:03 +08:00
    飞书知识库 会不会以后公网分享需要开会员呢?
    noparking188
        20
    noparking188  
       2022-11-02 22:29:50 +08:00
    这个项目能用来识别调查问卷的内容吗
    huntzhan
        21
    huntzhan  
    OP
       2022-11-02 22:34:35 +08:00
    @noparking188 识别调查问卷需要的是 OCR 软件,这个项目是用来“制造”OCR 算法服务的,所以单看这个项目,答案是不行。如果结合我们即将发布的 OCR 软件,就可以😄
    noparking188
        22
    noparking188  
       2022-11-02 22:39:46 +08:00
    @huntzhan #21 谢谢回答,期待发布
    ZxBing0066
        23
    ZxBing0066  
       2022-11-03 08:51:54 +08:00
    @huntzhan 首次加载速度很慢,可以看看 lighthouse 指标,有些拉垮,首次资源加载也着实多了些
    ZxBing0066
        24
    ZxBing0066  
       2022-11-03 09:16:05 +08:00
    @huntzhan 现在比昨天好多了,不过为啥 gif 图会影响整个页面的加载,也有点奇怪,图片全都 base64 打进去了吗
    huntzhan
        25
    huntzhan  
    OP
       2022-11-03 14:42:08 +08:00
    @ZxBing0066 感谢。综合测试下来目前已经放弃使用飞书知识库托管项目文档,原因:1) 加载速度慢,普遍反应需要加载 5~10s 才能出现页面 2) 有不小的概率( 10% 的受访用户)表示完全加载不出来页面。
    ZxBing0066
        26
    ZxBing0066  
       2022-11-03 18:47:10 +08:00   ❤️ 1
    @huntzhan 嗯,可以试试 docusaurus + vercel/各种 pages + cloudflare 加速感觉够用了
    deacyn
        27
    deacyn  
       2022-11-05 08:57:29 +08:00 via iPhone
    @huntzhan 确实加载缓慢
    samzong
        28
    samzong  
       2022-11-07 21:43:10 +08:00
    @nasa #19 背刺语雀 😅
    关于   ·   帮助文档   ·   博客   ·   API   ·   FAQ   ·   实用小工具   ·   5651 人在线   最高记录 6679   ·     Select Language
    创意工作者们的社区
    World is powered by solitude
    VERSION: 3.9.8.5 · 26ms · UTC 08:08 · PVG 16:08 · LAX 00:08 · JFK 03:08
    Developed with CodeLauncher
    ♥ Do have faith in what you're doing.