1.程序员如何写好技术文档？建议收藏
2.慕课mooc和慕课网是不是一个？
3.自学编程的app？
4.试验检测师道路工程哪个网校老师讲的比较好？
5.用Jenkins构建一个新工程，我们一起试一下！
6.Console 模块解读及简单实现

程序员如何写好技术文档？建议收藏

       文档的范围很广，本文特指开发人员撰写的包含基本产品背景和主要技术设计的文档。

       世界观为什么要写技术文档？

       写技术文档可以帮助团队完成当前的信息共享和长期的知识传承。对个人而言，得物源码一方面可以节省时间，因为避免了回答重复问题，也便于检索过去的知识；另一方面可以塑造口碑，比如某次突然有同事给我发消息说我的文档写的很好，对新接触这块业务的人帮助很大。

       某某同事的感谢

       反驳不需要写文档的言论

       有很多程序员都持有一个观点：“不用看(写)文档，文档都在代码里”，还有一部分人认为，文档容易过时，很难跟上代码的更新节奏，因而没有必要写文档。

       对此，首先我个人认为涉及代码细节的部分确实没必要写文档，但是对于总体的设计和业务的变更是绝对需要写文档的。有些人觉得文档有过时问题，那是因为他们没有引入版本（ChangeLog）的概念，过时的文档本身就是业务历史的一部分。在接手一个业务的时候，常常就需要这些历史信息来辅助理解。

       附议：为什么要看文档

       上周发生了一件趣事，一个产品跟我说，开发两句话能说明白的，为什么要看文档？确实，问开发能以最快速度准确地获取信息，毕竟人脑就是一个强大的搜索引擎。但是长期来看有以下问题：

       一般来说，一份好的技术文档比起开发口述是不会有多余的理解成本的，甚至更低，gotimer源码分析因为对于很多信息，能比语言更好地表达。

       什么算好的技术文档

       我认为好的技术文档的核心是敏捷。一方面，好的的技术文档是高度可维护的并且经常维护的，比如新增了一些功能，文档的作者能够快速更新文档，文档的读者能及时获取更新；另一方面，好的技术文档是易理解的，更详细来说要表述准确、结构清晰、排版美观、风格统一。

       文档&写文档的定义

       最后，我想探讨下写文档到底是干吗？百度百科说：软件文档或者源代码文档是指与软件系统及其软件工程过程有关联的文本实体。那么写文档就是生产这个实体的过程了。但这样实在过于抽象，根据我最近一年的经验来看，我更愿意将其定义为对特定信息进行结构化整理的过程。

       以上就是写作技术文档的道了，也就是我们对于这件事最基础的世界观，接下来谈术，即基于此执行的方法论。

       方法论基调

       在正式开始写文档之前，我们必须要有以下三点认知：

       结构

       本章节讨论了一份技术文档应该具备的各个单元，可以作为今后技术文档写作的框架或者Checklist。

       Introduction

       简单介绍项目背景信息，如下面是我为某个项目写的 Introduction ：

       Content

       目录，目录是结构的直接体现，必须有，一般文档写作工具都能自动生成：

       Terms

       术语解释，很多业务会衍生一些特定词汇，如“白条卡”、围棋保存源码“大图卡”等，都是有特定语境的，需要单独解释。

       Setup

       如何运行这个项目，一般开源项目都会有，如果是SDK文档也常常有接入文档，就是这个模块。

       Body

       这部分就是文档的主体部分，具体结构需要视内容而定，有以下通用规则

       对于具体的格式规范，推荐阅读 ruanyf/document-style-guide: 中文技术文档的写作规范。

       Reference

       这部分也可以放在附录里面，见下图。

       FAQ

       其他人经常问的问题，遇到就记录在这个模块，不断补充，日趋完善。

       Appendix

       一些比较冗长的信息可以放在附录里面，比如日志，避免放在正文影响排版和阅读。

       ChangeLog

       变更日志，一般开源项目都会记录每个版本的重要变更。

       ReleaseNote

       发版日志，一般开源项目都会有一个单独的Release页面。

       过程

       一般来说，文档写作的流程如下：

       收集信息、整理框架、实践结论、写作文档。如果前期工作足够，写作所花的时间是很少的。此外，文档完成后，flatter源码解析还要注意读者反馈，以不断完善自己的文档。写一份好的技术文档也不是一蹴而就的，需要不断打磨，要注意经常去刻意练习。

       工具

       写作工具

       一般来说，只要别人发给我的文档是一份Word文档，我基本就把这份文档排在了最LowB的一档。对于这种文档，我就想问两点：为什么不是Markdown或Asciidoc格式？Markdown比较受开源社区的欢迎，因为它在表达力和简洁性之间找到了一个平衡点，但是它有一个致命问题就是无法应付稍微复杂一点的排版。Asciidoc则是我的主力文档工具，很多人不知道Github也是支持这种文档格式的，比如本文就是这种格式的。Asciidoc的语法比Markdown更加复杂，但我认为牺牲一点时间学习是完全值得的。最后是Latex，Tex的变种，表达力最强大，可以应付各种复杂排版，一般在学术圈比较流行（尤其是那些复杂数学公式的表达），但我认为放在日常的文档写作中有点矫枉过正了。

       维护工具

       对于文档的管理，我推荐使用Git，像管理代码一样管理文档。另外我推荐使用一个静态网站来存放自己的文档，这样其他同事访问的时候看到的总是最新的文档了。另外，公司目前在推iWiki，我觉得iWiki最大的优势是权限控制，对于一些敏感文档是必须的。但是doubble源码分析，比起iWiki的变更记录，作为程序员的我更钟爱用Git进行管理，此外，iWiki是Web网页，编辑体验肯定也比不上本地自己配置的编辑器。当然，术没有绝对的优劣之分，也要看自己是否合适。

       总结

       以上，最近关于技术文档写作的一些思考。欢迎交流指正。

       作者：慕用

       链接：imooc.com/article/...

       来源：慕课网

慕课mooc和慕课网是不是一个？

       不是。

       慕课mooc是一个名词，指Massive open online course，大规模开放在线课程，是一种在线课程开发模式。

       慕课网是一个网站，是IT技能教育的MOOC平台，设有前端开发、PHP开发，JAVA开发、Android开发及职场计算机技能等课程。课程分初级、中级、高级三个阶段。

       慕课网是众多慕课mooc类平台中的一个。

扩展资料

       MOOC教学形式

       1、课程范围：以连通主义理论和网络化学习的开放教育学为基础。

       2、授课形式：课程不是搜集，而是一种将分布于世界各地的授课者和学习者通过某一个共同的话题或主题联系起来的方式方法。

       3、考试：每门课都有频繁的小测验，有时还有期中和期末考试。考试通常由同学评分（比如一门课的每份试卷由同班的五位同学评分，最后分数为平均数）。

       MOOC平台：

       1、Coursera：目前发展最大的MOOC平台，拥有相近门来自世界各地大学的课程，门类丰富，不过也良莠不齐。

       2、edX：哈佛与MIT共同出资组建的非营利性组织，与全球顶级高校结盟，系统源代码开放，课程形式设计更自由灵活。

       3、Udacity：成立时间最早，以计算机类课程为主，课程数量不多，却极为精致，许多细节专为在线授课而设计。

       4、中国大学MOOC

       5、Stanford Online：斯坦福大学官方的在线课程平台，与“学堂在线”相同，也是基于 Open edX 开发，课程制作可圈可点。

       6、NovoED：由斯坦福大学教师发起，以经济管理及创业类课程为主，重视实践环节。

       7、FutureLearn：由英国所高校联合发起，集合了全英许多优秀大学，不过课程要等到next year才会大批量上线。

       8、Open2Study：澳洲最大MOOC平台，课程丰富， 在设计和制作上很下工夫，值得一看。

       9、iversity：来自德国的MOOC平台，课程尚且不多，不过在课程的设计和制作上思路很开阔。

       、Ewant:由两岸五大交通大学（上海交大，西安交大，西南交大，北京交大，台湾国立交大）共同组建的MOOC平台。

       、WEPS:由美国与芬兰多所高校合作开发，开设多门数学课程。授课对象包括开设院校的在校学生，课程内容符合教学大纲要求，考试合格者可获得开设院校所认可的该课程学分。

       慕课学习社区

       、MOOC学院：最大的中文MOOC学习社区，收录了多门各大MOOC平台上的课程。有万学习者在这里点评课程、分享笔记、讨论交流。

       、学堂在线：清华大学于年月日推出的MOOC平台，面向全球提供在线课程 []  。

       、慕课网（imooc）：慕课网是由北京慕课科技中心成立的，是目前国内慕课的先驱者之一。现设有：前端开发、PHP开发，JAVA开发、Android开发及职场计算机技能等课程。其中课程包含：初级、中级、高级三个阶段。

       、酷学习（kuxuexi）：上海首个推出基础教育慕课的公益免费视频网站。

       百度百科-慕课

       慕课网-关于我们

自学编程的app？

       å­¦ç¼–程的软件有哪些

       å­¦ç¼–程的软件有：

       1、Dev-C++

       è¿™æ¬¾è½¯ä»¶æ˜¯æ‹¥æœ‰åŠŸèƒ½ç®€æ´ã€æŠ€å·§æç¤ºå’Œæ”¯æŒå¤šè¯­è¨€ç­‰ä¼—多优点，是在Windows环境下适合初学者使用的一款轻量级C/C++集成开发环销渗境。

       2、CodeBlocks

       ä½œä¸ºä¸€æ¬¾è½»é‡çº§çš„C/C++?IDE，它除了能够完成最基本的编辑、编译、调试的功能，还具备跨平台、跨编译器的特点，Windows、Linux、Mac?OS都可以使用，即使将来更换了设备也无需亏念脊担高虚忧。

       3、Sublime?Text

       è¿™æ˜¯ä¸€æ¬¾è½»é‡çº§çš„文本编辑器，支持多种语言的语法高亮及代码补全。具有高度的可拓展性以及?Vim?模式。Sublime?Text?具有漂亮的用户界面和强大的功能，例如代码缩略图，Python?的插件，代码段等。Sublime?Text?是一个跨平台的编辑器，同时支持?Windows、Linux、Mac?OS?X?等操作系统。

免费学习编程的软件

       å…è´¹å­¦ä¹ ç¼–程的软件如下：

       1、《编程狮》。这款软件有着多达十多年的编程教学经验，除了大量的编程课程以外，还为0基础编程的同学专门准备了入门课程，教学的话采用半学习半实战的方式，用户学习效率也很不错。

       2、《儿童编程启蒙》。这是专为孩子打造的一款编程启蒙软件，软件以动画积木代表代码，让其轻松了解到代码编程的原理，更有积木排序、积木移动等课程让孩子学会编程。比起让孩子学会多少编程知识，软件寓教于乐，更在意培养孩子对于编程的兴趣。

       3、《Python编程狮》。编程Python专项学习软件，除所有课程免费为用户开放以外，还免广告，是一款真正0门槛的良心软件。用户每腔猜天只需要挤出分钟的陪圆罩碎片化时间，即可轻松掌握编程Python的基础技能。

       4、《编程猫》。软件拥有大量图像化、Python的编程课程，除了收看教学视频以外，还芦闹有专门配置的网络班主任帮助用户学习，学习上有问题找班主任，想练习找班主任，在这里小白也能秒编程大师。

       5、《手机编程》。只要拥有一款手机，下载这款软件，即可变成电脑编程大师。软件内C、C+、Jaca和网页的编程教学资料非常多，并且通俗易懂，只要用户花时间，即可轻松掌握。

免费的编程自学软件

       å¯ä»¥è‡ªå­¦çš„编程软件如下：

       1、《点个猫》点个猫是一款趣味编程学习软件，通过搭积木的方式帮助用户学习编程语言，零基础也能轻松入门，丰富的图形化课程，让如腊枣你了解局培更多知识点，还有编程创作社区，小伙伴们可以一起分享交流编程作品。

       2、《编程助手》清爽的界面，简单的操作渣拆，涵盖甚广的编程语言，内容丰富多样的编程知识点，想要学习编程请不要错过编程助手这款软件，是小伙伴们轻松学习编程的好帮手。

程序员刷题app有哪些

       ç¨‹åºå‘˜åˆ·é¢˜app有如下这些：

       csdn：

       ç®€åŽ†å‡ä»‹ï¼šè¶…万用户都在用的编程学习App。

       æ…•è¯¾ç½‘课程app：

       ç®€ä»‹ï¼šæ…•è¯¾ç½‘（imooc.com）是专业IT技能在线学习、公开课平台，开发工程师自学必备网站。

       ç™¾æˆ˜ç¨‹åºå‘˜ï¼š

       ç®€ä»‹ï¼šJava编程狮是W3Cschool编程狮旗下专门为零基础Java编程爱好者打造的一款入门工具App，致力于帮助初学者入门，轻松迈入编程领域。学Java，从这里开始！

       æ‰‡è´ç¼–程免费版：

       ç®€ä»‹ï¼š"扇贝编程将带领你在不经意之间从0到1掌握编程奥秘，写出人生第一行代码，带你打开编程世界的大门！天精通python语言，掌握爬虫答早技术、数据分析方法，入门人工智能，未来，就是现在！

       Java语言学习：

       ç®€ä»‹ï¼šJava教程：Java语言语法知识，包括肢举老Java数据类型、运算符、控制语句、类和对象等语法知识。

       ç‰›å®¢ç½‘：

       ç‰›å®¢ç½‘，是一个集笔面试系统、题库、课程教育、社群交流、招聘内推于一体的招聘类网站。牛客网题库中包含几万道题目，主要通过第三方购买和UGC的方式获得，牛客网先后尝试了直播和录播课，内容覆盖笔试题解析、面试技巧和机器学习等，校招，一定要关注。

       è‡ªå­¦ç¼–程软件有哪些？

       1、桌面、效率工具Onenote

       onenote就像纸质的笔记本。收集资料、知识管理、强悍的复制图像的文字，简直是好用到不怎么需要介绍。

       2、阅读/编陆悉祥写代码：Notepad++

       æ¯«ä¸å¤¸å¼ åœ°è®²ï¼Œè‡³å°‘有早搏、%的程序员用过这款工具。这款编辑器确实挺好的，支持代码高亮显示，而且适用于多种语言，有ada,php,java.c#,c++等。

       3、sublimetext3

       SublimeText在OSX、Linux和Windows三大平台都可以使用。

       è¿™æ¬¾ä»£ç ç¼–辑器拥有多选、宏、代码片段等功能，并且还有极具特色的Minimap。

       4、编写代码:SourceInsight

       ç¼–写代码除了使用Notepad++之外，也可以选择SourceInsight。

       å®ƒæ˜¯ä¸€ä¸ªéžå¸¸å¼ºå¤§çš„强大的程序编辑器。可快速访问源代码和源信息的功能。

       5、流程图visio

       ç¨‹åºå‘˜åšæµç¨‹å›¾çš„软件，很少有几款可以和Visio媲美的。它可以将复杂信息、系统和流程可视化、分析，陆态受到大量程序员的喜爱。

试验检测师道路工程哪个网校老师讲的比较好？

       很多朋友都想利用闲暇时光学一点东西，但是想要自学，好的平台是很重要的，你是否也苦于没有好平台进行学习呢？现在就给大家整理了+个高质量学习网站+多位位高质量up主，特别适合大学生、职场人是、考研、高中生等群体。

       总共划分为 8 个类目，B站、技能学习、综合学习、实习就业、文献资料、扩展视野、留学考研等，希望能帮到大家。

       1. B站综合学习（6类目，个up主）

       B站除了是一个二次元网站，同样也是一个高质量的学习网站。作为一名B站的深度使用者，在这里给大家分享 个超高质量的学习up主。

       1.1 全能类软件教学（B站up主：Oeasy）

       一位超级硬核的up主，在B站上拥有w+粉丝，上到编程入门、平面设计、Office技能，下到嘴硬核的电路设计，这位up主都有分享了非常详细的视频教程，并且整体的质量还非常不错，如果是想自学的，那么不妨可以看下，在B站学习，独特的弹幕文化交流，让学习像娱乐一样轻松。

       链接：/

       2.3 慕课网（程序员的梦工厂）

       作为IT在线教育的Top1，有上千万人曾经在慕课网上学习过，参加最多的一门课甚至超过了w为程序猿，质量也是杠杠的，包含：HTML/CSS、大数据、Python、爬虫、云计算、Android、Java、小程序开发等等。

       同时课程拥有免费+付费增值的形式，可以供你任意选择，为知识投资是最伟大的投资。

       链接：mooc.org/home/index.mooc

       7. 文献资料（6个网站）

       7.1 学术堂（专业论文学习平台）

       正逢需要写毕业论文的时间，如果还不懂的毕业论文是如何写的，那么这个网站一定要收藏好，包含了：范文、格式、题目、开题报告、摘要提纲、正文写作、参考文献等等，一系列的论文相关知识。

       同时还非常良心地提供了众多论文模板：经济学、管理学、社会学、工程、水利、农业等等。

       链接：ki.cn-ki.net/

       7.3 云海电子图书馆（免费电子书下载）

       学习的过程中难免会碰上寻找书籍，网上购买实体书速度又非常慢，而且有非常多的小伙伴希望看电子书，但是苦于没有一个下载电子书的地方，云海电子图书馆它来了！

       在这里，你可以免费下载收录的所有电子书，涵盖了：投资理财、经济管理、小说、文学、励志成功、传记、健身与保健等等。

       链接：/

       7.4 网易数读（信息图参考）

       一个非常有意思的的新闻栏目，利用可视化的精美来展示新闻，也是一个非常不错的信息文献借阅途径，无论对你写学术论文，还是了解时事都非常有帮助。

       链接：blogs.com/wendingding/p/.html

        5.FaceBook

       .io

        7.唐巧的技术博客

       /s/blog_9c3cbfmz.html

        .博客  loadView、viewDidLoad及viewDidUnload的关系

       blogs.com/ygm/p/.html

        .使用 Xcode 和 Instruments 调试解决 iOS 内存泄露

       /mobiledev/.asp

        .iOS开发中常见的一些bug

       .io

        .ViewController的切换

       /s/blog_4ca9ceefisvc.html

        .iOS 平台 Cocos2d-x 项目接入新浪微博 SDK 的坑

       blogs.com/ios-wmm/

        .菜鸟笔记

       blogs.com/hanyonglu/archive////.html

        、 iOS开发多线程篇—多线程简单介绍

       blogs.com/wendingding/p/.html

        、KVC 与 KVO理解

       blogs.com/ios8/archive////ios-Singleton.html

        . 一些第三方库的了解

       /thanklife/article/details/