【心得分享】关于MarkDown文档的撰写

问题描述

**为什么要用 MarkDown 写文档**最开始接触 MarkDown 其实是在研究各种 Wiki 系统时看到的。因为不明白 MarkDown 是什么东东,所以就手贱的搜索了一下。然后,本能地学习它的语法结构。刚上手时,感觉相当不习惯。从我的个人感受来说有以下几点:不熟悉 MarkDown 的语法,总是要查手册。(又要记好多东西啊……)没有好用的工具,和语法高亮。(和 txt 看着差不多……)没有所见即所得来的方便。(还不如 Word 嘛……)接受 MarkDown 是在观察了 GitHub 上的表现之后,而且发现了很多方便的地方:git、svn 等工具的比对功能还是相当方便的。(这是主要原因……)很多开源工具支持解析MarkDown语法(我用 Adobe 的 Brackets,插件还是很方便的……)写起来感觉越来越省事……(或许是吐着吐着习惯了……)**自己简化 MarkDown 的语法**MarkDown 不好学就是因为要记一些规则,而且没啥提示。我记得有本书《深入浅出……》,提到人脑记忆的一点点小规律哈。就是要让脑子认为这个东西简单到和“老虎很危险,看见要逃跑”这么简单,脑子就能记住。“#”代表标题(语文学渣谈协作……)“-”和“n.” 代表无序和有序列表“(url)”代表链接“!(url)”代表图片当然还有好多好多语法,往上能够找到,我就不在这里多说了。记住上面这些,一般的项目文档,我觉得就足够了哈。**参考**http://daringfireball.net/projects/markdown/http://wowubuntu.com/markdown/

时间: 2025-01-21 10:27:11

【心得分享】关于MarkDown文档的撰写的相关文章

对文档的撰写新的领悟:简洁,清晰

文章描述:写文档的一些技巧. 最近带一个毕业生,他让我对文档的撰写有了一些新的领悟,跟以前的结合起来一起说一下: 首先,我个人在写文档方面有2个特点:简洁,清晰 简洁:能用一句话说清楚的绝不用第二句,用最简单的句子 清晰:结构清晰,让人一目了然:逻辑清晰,尽量减少读者的理解成本:重点清晰. 对内的文档 对上级:由于上级的时间都很宝贵,所以对上级的文档建议使用"金字塔原理"(<金字塔原理>是一本很不错的书,推荐阅读).先用简练的开头让老大知道整个文档的核心内容(分析结果.方案

工具分享——将C#文档注释生成.chm帮助文档

原文:工具分享--将C#文档注释生成.chm帮助文档 由于最近需要把以前的一个项目写一个文档,但一时又不知道写成怎样的,又恰好发现了可以生成chm的工具,于是乎我就研究了下,感觉还不错,所以也给大家分享下.好了,不多废话,下面就来实现一下吧. 生成前的准备 在开始做之前,还是要补充说明一点:我们是通过C#文档注释生成的XML文件来生成帮助文档的.因此,第一步就是生成XML文档: 具体步骤:打开VS->随意创建一个项目(这里我用的是控制台项目),然后添加如下内容: /// <summary>

分享如何利用文档推广自己的网站

随着互联网的发展,上网的人群越来越多,面对五花八门的网络营销广告,混网络时间稍微长点的用户都能辨别.用户对广告辨识度不断提高,使得营销效果大打折扣,同时鞭策网络营销人员不断提升自己营销技巧能力,绞尽脑汁寻找新的推广模式,以保持营销效果最大化. 互联网分享理念的深入,文档分享平台如雨笋般崛起,通过文档分享平台推广自己的网站,不失为一个新的互联网推广模式. 下面就和大伙分享如何利用文档推广自己的网站,以及分享中国几大出名文档平台推广经验. 一:文档.文档分享概念 1.文档: 咱们所说的文档,指的是电

WPS移动版文档分享邮件微博网盘全体验

对于广大学生.上班族或SOHO白领来说,由于学习.工作等因素,经常要用手机或平板电脑阅读或编辑相关资料,诸如学习资料.策划方案.调查报告.详实权威的数据甚至工作日记等,且在必要情况下要将这些资料与别人分享,那么在移动终端上,如何才能同时实现资料文档的阅读.编辑和分享呢?别急,金山WPS Office移动版就可以满足你的应用需求. 一.邮件分享轻松完成 如今互联网上的Office软件有许多,除了Microsoft Office外,WPS Office是国人使用最广泛的办公软件了,完美支持多种文档格

设计文档的制作经验分享

最近准备做一个设计文档的分享,但是一直没有时间整理好keynote,这里先分享一个设计文档模版,以及模版中每个元素的使用理由与方法.之后的设计文档分享中,会加入更多的设计文档案例来分析讨论. Here we go. 作为一个交互设计师,我们要全局掌握产品的背景,逻辑,用户体验.但是,我们不能忽略设计过程中一个很关键的步骤,设计输出. 如果我们用email或者其他大海报的方式来输出设计文档,有没有产品经理会抱怨说看不懂?有没有开发抱怨使用过程中效率低?在我之前的工作经验中,我一直保持用一种方式来输

如何把word文档内容以图片的形式分享到微博的方法

  第一步:准备一篇microsoft word 文档,然后打开该文档. 第二步:点击word文档菜单栏里的"特色功能",而后再点击"长微博",这是就会显示一个下拉框. 第三步:在下拉框中选择"分享到微博",而后在网页端就可以看到"WPS微分享". 第四步:在这里我们将word文档内容分享到新浪微博就行了,当然你也可以分享到腾讯微博,点击"分享到微博"即可. 第五步:在你的新浪微博登录的前提下,点击&quo

把word文档内容以图片的形式分享到微博的方法

  第一步:准备一篇microsoft word 文档,然后打开该文档. 第二步:点击word文档菜单栏里的"特色功能",而后再点击"长微博",这是就会显示一个下拉框. 第三步:在下拉框中选择"分享到微博",而后在网页端就可以看到"WPS微分享". 第四步:在这里我们将word文档内容分享到新浪微博就行了,当然你也可以分享到腾讯微博,点击"分享到微博"即可. 第五步:在你的新浪微博登录的前提下,点击&quo

吴锋:利用文档分享平台推广自己的网站

中介交易 SEO诊断 淘宝客 云主机 技术大厅 随着互联网的发展,上网的人群越来越多,面对五花八门的网络营销广告,混网络时间稍微长点的用户都能辨别.用户对广告辨识度不断提高,使得营销效果大打折扣,同时鞭策网络营销人员不断提升自己营销技巧能力,绞尽脑汁寻找新的推广模式,以保持营销效果最大化. 互联网分享理念的深入,文档分享平台如雨笋般崛起,通过文档分享平台推广自己的网站,不失为一个新的互联网推广模式. 下面就和大伙分享如何利用文档推广自己的网站,以及分享中国几大出名文档平台推广经验. 一:文档.文

产品需求文档(PRD)的写作方法之笔记一

1.写前准备(思维导图): http://www.woshipm.com/?p=80070 1.在写之前,请先很区分清楚什么是MRD文档(市场需求文档),BRD文档(商业需求文档),什么是PRD文档(产品需求文档) 可查阅知乎https://www.zhihu.com/question/19655491 2.规划产品的思维导图(信息结构图) 在写作这份文档前,我们需要先做一些准备,把BRD.MRD的相关需求消化并融合规划出产品的结构图.因为这些准备工作是属于思维类的,所以我推荐使用思维导图软件(