语言与文风2014alistapart.com
如何创建风格指南
Creating Style Guides
导读
这是一篇 A List Apart 的文章,讲如何为网站或产品建立“样式指南”:把全局规则和各个组件分开整理,每条都配上视觉示例和代码示例,让团队有一致、可执行的标准。对写作者来说,它提醒我们“风格指南”不只属于设计:把凭感觉的品味写成明确规则和范例,才能让自己和合作者稳定地产出。
可以直接用的写作要点
- 01
把“全局规则”(语气、用词、格式)和“具体条目”(某类内容怎么写)分开整理,先定总则,再拆细则。
- 02
每条规则都配一个正例或反例,就像原文的视觉示例与代码示例,让抽象标准变得可照着做。
- 03
给自己建一个“沙盒”:随手试写、快速试错,早点发现语气不一致或读者不适的问题,别等到成品才返工。
- 04
让指南和实际产出共用同一套素材,比如同一批范例句、同一个词表,避免指南和真正写出来的东西脱节。
HN 评论精选
指南要分层(全局规则+组件示例),并且和可试用的沙盒、实际产出共用同一套素材,标准才能真正落地。
这位评论者说,他们正在做的样式指南做法和文章很像:先给全局元素一个总体说明,再把各个组件单独列出,附上视觉示例和代码示例。他还做了一个沙盒,可以随时把每个组件放进去测试,快速试做新页面和新组件,也能更早发现文章提到的那类浏览器兼容问题。样式指南和沙盒共用同一批组件,加一个新组件两边都会出现;共用的 LESS 主文件也能直接用到生产环境。他认为,让团队把想法尽快变成现实是自己的职责,而有一套标准一致的强样式指南对此很关键。
LandoCalrissian查看英文原文
This is a great example of the way I think it should be done. On the style guide I'm currently working on we do it very similar fashion. We have the general overview for global items and then individual components broken out with visual examples as well as code samples. I also have been working on a sandbox where you can bring in each component on the fly and test it in a sand boxed environment. This allows us to quickly prototype new views and components. Also let's us catch more of those browser specific bugs as mentioned in the article. The style guide and sandbox share the same components, so when you add a new component it appears in both. Then there are the master LESS files which are also shared, that can easily be moved into production. It's our job to make it as easy as possible for the team to come up with an idea and move that vision to reality. Having a strong style guide with consistent standards I think is really important to that. Thanks for sharing the article!
指南的难点不在制定,而在如何让非专业的相关方接受“按规则来”而不是“凭感觉”。
这位评论者完全同意要有样式指南,但提出一个实际问题:怎么向不懂技术的客户解释样式指南?样式指南看起来偏技术,她不太确定该怎么简明地告诉客户,界面和体验的决策应该依据指南,而不是凭“哪个感觉好”。
kat查看英文原文
I totally agree with the idea of having a style guide. How do you educate non-technical people (customers) on style guides? Style guides seem technical in nature so I'm not too sure how to succinctly explain to a customer that UI/UX decisions should be based around guidelines instead of "what feels good"
同类还值得读
像说话一样写作
Write like you talk
这篇短文主张写作应像说话一样自然、清晰,避免装腔作势的书面腔。
语言与文风2015 · 647 分 · 272 评4 条写作要点编辑精选法律语言难懂源于写作不佳,而非专业概念
Poor writing, not specialized concepts, drives difficulty with legal language
这是一项认知科学研究:法律文本难懂,主要不是因为充斥专业术语,而是因为写作者把句子写得又长又绕、修饰语层层嵌套、回指距离过远。
语言与文风2022 · 559 分 · 322 评5 条写作要点编辑精选写得简单
Write Simply
保罗·格拉汉姆在这篇短文里主张:好文章应该写得简单——用日常词汇、短句、直白的结构,不为显得聪明而堆砌复杂表达。
语言与文风2021 · 484 分 · 330 评4 条写作要点编辑精选Tortured phrases:科学写作中出现的一种可疑文风
Tortured phrases: A dubious writing style emerging in science
《自然》新闻报道了一种在科学论文中蔓延的怪现象:原本标准的术语被同义替换软件改写成了古怪说法,比如把 "cloud computing" 写成 "haze figuring"。
语言与文风2021 · 329 分 · 256 评4 条写作要点编辑精选乔治·奥威尔 1940 年对《我的奋斗》的书评
George Orwell's review of Mein Kampf (1940)
这是奥威尔1940年对《我的奋斗》的书评。
语言与文风2014 · 305 分 · 240 评4 条写作要点编辑精选