论文档的重要性

今天下午看了几个基于angular的UI框架,发现Google自主开发的Angular Material挺不错的。虽没有仔细研究,但官方提供的demo我决定在自己的项目上用上一用。UI框架不同于其他前端模块和插件,在选择的时候开发人员一般会采用比较保守的态度,因为一旦从项目开始采用某种框架,中途发现问题再进行替换的成本极大,而且基本也不能多种框架混用,只能一条道走到底。

目前被应用最为广泛的应该是Twitter提供的Bootstrap了,之前接触的项目中Bootstrap可以算是标配了,所以用起来也比较顺手,但是感觉一直采用这个框架会陷入设计和审美上的局限,这次借着自己的新项目打算换换口味。查了一下网上的UI库还是很多的,看了看演示的demo都很酷炫fancy,最后选择Angular Material主要还是觉得Google出品,质量有保证。然后就在想,为什么Bootstrap能从众多框架中脱引而出,除了产品本身的特性外,一个良好的文档绝对是很重要的一个原因。

开发者了解产品的最主要途径就是产品的官方网站和Github,Bootstrap的所有使用指导都可以在官方网站找到:http://v3.bootcss.com

Bootstrap官网首页

首页提供了下载链接,一些简短的的特性说明,大多数偏技术的互联网产品的官网多采用此风格,让初次来到网站的访问者能快速了解和接触到产品,作出初步判断该产品是否符合自己的期望。同时首页也是一个技术团队展示自己能力的所在,Bootstrap的网站采用自身的响应式技术对页面的自适应做了不错的设计和处理。

起步页面介绍了常用的下载和使用方法。包括源码下载,CDN引用,bower和npm安装,基本入门指导,版本升级和浏览器支持等常见问题。值得注意的是页面布局是左侧内容,右侧固定导航栏,在页面滑动到某一部分,对应的导航栏就会展开该部分的子目录,非常清晰明了。


起步页面截图

Bootstrap的主要功能介绍放在了CSS样式,组件和JavaScript插件三个页面。这也是使用过程中经常查看的页面。其中CSS介绍通过元素设置class得到CSS样式和布局效果,比如text-left达到字体左对齐等等。其中对于一个UI框架最为重要的布局-栅格系统也在这里做了非常详细的介绍。通过实例+实现代码的方式把使用过程中的所有情况都做了展示和介绍,基本可以达到所见即会用。如果是新手,在看了如此详尽易懂的说明后,应该都会很有信心去尝试和使用。颜色的使用上所有使用方法采用红色,重点文字加粗,标题采用超大字体和正文对比明显,很容易理解页面结构。


截图栅格系统说明

组件和JavaScript插件页面分别介绍了常用的静态和动态组件。在组件页的一开始,采用了完全罗列的方式展示了所有自带的icon,虽然占据了比较长的篇幅,但我想在设计的时候应该是希望人们查阅的同时就可以最快速的复制到自己的代码中使用,相比之下font-awesome就麻烦不少。应该说制作文档的工作人员真的把贴心做到了极致,针对每一个部分可能遇到的问题都用最准确的文字和代码提供了尽可能的介绍和说明,而不是采用问题汇总的方式需要遇到问题再花精力查找。


随处可见的说明

本来晚上是想写写文档对于产品的重要性,结果不知不觉把Bootstrap的网站夸了个遍。其实在开发产品的同时,维护一个好的文档花费的时间和精力也是蛮多的,但好的文档不能成就一个产品,优秀的产品绝对需要好文档。

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 203,098评论 5 476
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 85,213评论 2 380
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 149,960评论 0 336
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 54,519评论 1 273
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 63,512评论 5 364
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,533评论 1 281
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 37,914评论 3 395
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,574评论 0 256
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 40,804评论 1 296
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,563评论 2 319
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,644评论 1 329
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,350评论 4 318
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 38,933评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,908评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,146评论 1 259
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 42,847评论 2 349
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,361评论 2 342

推荐阅读更多精彩内容

  • Android 自定义View的各种姿势1 Activity的显示之ViewRootImpl详解 Activity...
    passiontim阅读 171,382评论 25 707
  • 发现 关注 消息 iOS 第三方库、插件、知名博客总结 作者大灰狼的小绵羊哥哥关注 2017.06.26 09:4...
    肇东周阅读 12,016评论 4 62
  • 问题1:本机的docker 和容器里都不能进行docker pull 操作 原因分析:当我们运行docker pu...
    星期六1111阅读 85评论 0 0
  • 人体要气血平衡,才会精神抖擞,百病不侵.健康不健康最重要的就是看气血是否平衡。 那么,什么是气呢? 从中医角度来讲...
    walker小凯阅读 177评论 0 1
  • 候引,r9,陈a59
    小姨妈此生偏爱海阅读 118评论 0 0