V2EX = way to explore
V2EX 是一个关于分享和探索的地方
现在注册
已注册用户请  登录
codists
V2EX  ›  程序员

关于《“宕机”一词在技术文档中如何表达?》的一点思考

  •  
  •   codists ·
    codists · 2021-02-25 09:18:36 +08:00 · 2630 次点击
    这是一个创建于 1368 天前的主题,其中的信息可能已经有所发展或是发生改变。

    说明:本主题无意于争吵,只是对原主题中的一些现象进行讨论。原主题详见:“宕机”一词在技术文档中如何表达?

    一、不查证现象

    作者在原主题中写到“但是我感觉“宕机”一词,像是口语。”。根据百度百科中宕机的定义:宕机是计算机术语。所以“宕机”隶属于计算机专业术语,而不是口语。但凡作者搜索下该词,就不会说出这种“我感觉”,“我觉得”之类的话。当然,这里并不是要指责作者,而是指责这种根据感觉来的,随意的现象。尤其是在技术文档写作中,更不应该出现。

    二、随意参考的想象

    作者在原主题中提到《中文技术文档写作风格指南》。上一个问题是不参考,而这个问题属于随意参考。不得不说,这份指南的问题很多。如 @geelaw 就指出了一个。我们再来看看其它的问题:

    ( 1 )在“关于本指南”一节,作者使用了英文 Contents 代替“目录”之意,明显是不妥当的。

    ( 2 )在“语言风格”——“简洁清晰”一节,作者提到“尽量用主动时态,尤其要阐述清楚主语和宾语”。时态怎么会有主动被动呢?只有语态才有。

    ( 3 )在“名称与命名”——“文件命名”一节,作者将“-”称为“短划线”。短划线是中划线,还是下划线呢?这里明显也是不妥当的,应该称为“中划线”。

    对于这样一份错误百出的文档,我们实在不应该将其作为参考文档。个人认为,选择参考文档时可以考虑一些组织级别或者公司级别的规范,如 daocloud 公司的写作规范和格式规范。少选择个人撰写的规范。如果要选择个人撰写的规范,建议尽量选择长期深耕该领域的人员所撰写的,如阮一峰的中文技术文档的写作规范

    23 条回复    2021-02-25 16:06:42 +08:00
    shareSK
        1
    shareSK  
       2021-02-25 09:27:25 +08:00
    daocloud 最后的注释"有研究显示,打字的時候不喜欢在中文和英文之间加空格的人,感情路都走得很辛苦,有七成的比例会在 34 岁的時候跟自己不爱的人结婚,而其余三成的人最后只能把遗产留给自己的猫。毕竟爱情跟书写都需要适时地留白。 —vinta/paranoid-auto-spacing ↩"
    这对我是极大的侮辱!
    mikeguan
        2
    mikeguan  
       2021-02-25 09:28:07 +08:00 via Android
    Daocloud 里面的常用名词,登录有问题。
    k10ndike
        3
    k10ndike  
       2021-02-25 09:42:53 +08:00 via Android   ❤️ 2
    等一篇 关于《关于《“宕机”一词在技术文档中如何表达?》的一点思考》的一点思考
    felixcode
        4
    felixcode  
       2021-02-25 09:52:22 +08:00
    百度百科能作为依据吗?
    这种百科看看可以,作为参考依据也太不认真了吧。
    Slartibartfast
        5
    Slartibartfast  
       2021-02-25 09:53:51 +08:00 via iPhone
    百度百科笑了
    czfy
        6
    czfy  
       2021-02-25 10:13:19 +08:00
    1. 百度百科是不可信的,你既不会在学术论文里引用,也不应该在商业等业务场景引用
    2. 第一次听说目录的英文用 contents 是“不妥当”的
    SuperMild
        7
    SuperMild  
       2021-02-25 10:31:46 +08:00   ❤️ 1
    我看到很多提问的贴子也觉得发贴的人太“随意”,各种不查证。但转念一想,其实发贴可能只是为了水一水、摸个鱼,而不是真的问问题。
    Jooooooooo
        8
    Jooooooooo  
       2021-02-25 10:33:16 +08:00
    引用百度百科那基本没有说服力. 换个权威信源吧.
    codists
        9
    codists  
    OP
       2021-02-25 10:41:19 +08:00
    @czfy
    你好,是这样的:
    1 、针对大佬提的第一个问题。这里不是说在学术论文里引用,也不是说在商业等业务场景引用百度百科。我的意思是我们在写文档的时候要查证,百度百科只是举例,也可以查维基百科,也可以查书籍,以及其它资料等等。重点是要查证,而不是凭感觉,也不是就完全相信所查找资料的内容。
    2 、针对大佬提的第二个问题。我的意思在中文文档中,contents 可以翻译成目录,但是作者依然在中文文档中使用的是英文,不恰当。不是说用 contents 表示“目录”错误。希望没有给你带来无解。
    codists
        10
    codists  
    OP
       2021-02-25 10:44:31 +08:00
    @shareSK
    这里我同意大佬的观点,我也觉得这样写也不好。
    同时我也想在重申一遍我的观点,就是希望选择参考文档的时候,在公司撰写的文档和个人撰写的文章中尽量选择公司制定的文档规范。这里不是说公司指定的规范就一定是对的。
    source
        11
    source  
       2021-02-25 10:49:30 +08:00
    @czfy #6 2.再看一遍楼主的原文,阅读理解一下,楼主明显是指在中文语境下故意用英文 contents 而不使用广泛认同的汉字词汇“目录”,是不专业的
    codists
        12
    codists  
    OP
       2021-02-25 10:50:07 +08:00
    @mikeguan
    感谢大佬提出的意见。在这里我也认为应该使用“登录”。同时,以这些文档为参考,不是说就全盘照搬参考文档的。再次感谢。
    codists
        13
    codists  
    OP
       2021-02-25 10:52:28 +08:00
    @felixcode
    你好,我没有说以百度百科作为参考资料。
    我的意思是:1 、没查证之前尽量查证。2 、查证的时候尽量选择可信度较高的内容。
    codists
        14
    codists  
    OP
       2021-02-25 10:54:30 +08:00
    @Slartibartfast
    你好,百度百科只是一个举例,也可以是《现代汉语词典》、法律材料等资料。这里这是像表明要查找资料。当然,查找资料的时候我们也需要进行辨别。
    codists
        15
    codists  
    OP
       2021-02-25 10:57:25 +08:00
    @k10ndike
    大佬,你好。本主题的两个观点:1 、没查证的时候尽量查证。2 、查证的时候尽量选择可信度较高的资料。如果觉得有表述不妥当的地方,可以具体说说,如果说的有道理,我接受批评。
    codists
        16
    codists  
    OP
       2021-02-25 10:59:52 +08:00
    @SuperMild
    可能吧,同时我也希望对其它有需要的的人有所帮助。
    mxalbert1996
        17
    mxalbert1996  
       2021-02-25 11:10:34 +08:00 via Android
    @czfy contents 这个词本身并没有中文“目录”的意思,只是它单独出现在特定位置时可以翻译成“目录”。如果想要在文章中提到目录,应该用“table of contents”。
    k10ndike
        18
    k10ndike  
       2021-02-25 11:13:08 +08:00 via Android
    @codists 这不明显是在调侃吗……不过用百度百科举例,确实和整个论证自相矛盾
    felixcode
        19
    felixcode  
       2021-02-25 11:20:20 +08:00 via Android
    @codists
    百度百科恰恰是可信度低的,既不适合作为参考资料,也不适合作为查证使用,你拿自己举了一个反面案例。

    事实也是有时查百度百科不如不查。
    morize
        20
    morize  
       2021-02-25 12:03:33 +08:00
    虽然我不用百度百科,但是作为参考资料,维基百科或者以后有人发明一个什么香蕉百科都是同等水平的吧。
    Cielsky
        21
    Cielsky  
       2021-02-25 12:07:16 +08:00
    百度百科你可以看下最下面的参考资料就知道宕机这个词条合适不。
    感觉去查查最新的现代汉语词典更靠谱点吧。
    Slartibartfast
        22
    Slartibartfast  
       2021-02-25 12:20:43 +08:00 via iPhone
    @codists 那举一个词典收录宕机的例子?

    宕机本来就是口语词汇,这几年逐渐出现在很多不严谨的场合,但是严肃的计算机专业教材上没有引用。

    未来有可能会有,但是至少到目前为止还不是专业词汇。

    此外如果把宕机局限于单台服务器故障,我是认同的,但是延伸出什么网站宕机,简直胡扯
    godgc
        23
    godgc  
       2021-02-25 16:06:42 +08:00
    严谨有严谨的乐趣,反思有反思的益处,没啥好再多探讨的哦,说的多了就过度解读了
    关于   ·   帮助文档   ·   博客   ·   API   ·   FAQ   ·   实用小工具   ·   938 人在线   最高记录 6679   ·     Select Language
    创意工作者们的社区
    World is powered by solitude
    VERSION: 3.9.8.5 · 25ms · UTC 22:10 · PVG 06:10 · LAX 14:10 · JFK 17:10
    Developed with CodeLauncher
    ♥ Do have faith in what you're doing.