虽然市面上有很多优秀的风格指南,但当我开始编写技术手册和文档时,我个人选择的是《IBM Style Guide: Conventions for Writers and Editors》[0]。它写得太全面了,以至于这本书本身就完全契合了书里定下的规范,就好像它是某种……
While there are many excellent style guides out there, I personally went with the IBM Style Guide: Conventions for Writers and Editors [0] when I started writing technical manuals and documentation. It is so comprehensive that the book ends up describing itself exactly, as if it were some kind of…
……是一位非常出色的 content strategist)。他们必须得是。补充点背景,我是 Red Hat 内容团队的前成员,我之前是从大企业跳槽过去的,当时发现团队居然依赖 IBM Style Guide,感到挺沮丧的。于是我推动 Red Hat 搞了一套权威的开源 style guide,因为我研究过工程和 tech writing 之间的通用模式,如果不同团队写的东西不一致,就会在 UI 或 API 层面造成脱节,比如某一组最后写成……
…is an amazing content strategist). They have to be. For context, I'm an alumni of the Red Hat content team, which I joined from a corporate background and was frustrated to see the team relied on the IBM Style Guide. I pushed for Red Hat to make a canonical open source style guide, as I researched common patterns across engineering and tech writing that can create disparity in UIs or APIs if one group ends up writing…
虽然市面上有很多优秀的风格指南,但当我开始编写技术手册和文档时,我个人选择的是《IBM Style Guide: Conventions for Writers and Editors》[0]。它写得太全面了,以至于这本书本身就完全契合了书里定下的规范,就好像它是某种……
While there are many excellent style guides out there, I personally went with the IBM Style Guide: Conventions for Writers and Editors [0] when I started writing technical manuals and documentation. It is so comprehensive that the book ends up describing itself exactly, as if it were some kind of…
……是一位非常出色的 content strategist)。他们必须得是。补充点背景,我是 Red Hat 内容团队的前成员,我之前是从大企业跳槽过去的,当时发现团队居然依赖 IBM Style Guide,感到挺沮丧的。于是我推动 Red Hat 搞了一套权威的开源 style guide,因为我研究过工程和 tech writing 之间的通用模式,如果不同团队写的东西不一致,就会在 UI 或 API 层面造成脱节,比如某一组最后写成……
…is an amazing content strategist). They have to be. For context, I'm an alumni of the Red Hat content team, which I joined from a corporate background and was frustrated to see the team relied on the IBM Style Guide. I pushed for Red Hat to make a canonical open source style guide, as I researched common patterns across engineering and tech writing that can create disparity in UIs or APIs if one group ends up writing…