热门标签 | HotTags
当前位置:  开发笔记 > 编程语言 > 正文

Markdown编辑器对比分析

需求描述我们工作中需要向客户发布软件Specification说明书,它包含软件功能描述,使用方式,以及各接口的描述,同时要识别每个版本中的接口变更,形成ReleaseNotes并通知客户。

需求描述

我们工作中需要向客户发布软件Specification说明书,它包含软件功能描述,使用方式,以及各接口的描述,同时要识别每个版本中的接口变更,形成ReleaseNotes并通知客户。

我们的 Specification是使用Word文档来承载,开发人员每次修改时无法做review,每轮迭代完成后,会遇到两个问题:

  • 开发人员每次对Specification修改,无法做Review,无法保障每次修改的质量
  • 经过一轮迭代之后,开发人员无法准确回忆此过程当中的修改,哪些是涉及的接口变更的

解决方案

经过设计师和架构师们的讨论,解决问题需使用以下的流程控制:

  • 所有有的Specification必须要经过git提交和review,才能做每次修改作review,保证内容经过检视
  • 如果涉及接口的变更,需要在ChangeLog是按固定的格式填好,每轮迭代完成之后,通过脚本自动抽取并形成变更列表

我提出了Markdown方案,开发人员使用Markdown本地编辑器写Specification,确认修改无误之后通过git提交,涉及接口描述变更的,按规定的ChangeLog格式填好信息提交。经过其它工程师review无意见之后,再入库。

经多方讨论后同意使用Markdown方案,属于资料工程架构的重新设计。

为了能让工程师专注Specification内容的编写,需要选用适合的Markdown编辑器,下面是对几款主流的工具做对比分析。

Markdown编辑器对比分析

我们工作平台是window,从易用性来说,只选用window平台的。从公司选用软件的要求,最好或者尽量不要选用商用付费软件,开源是最优的选择。

目前只分析了Atom和MarkdownPad2两工具。 有更好方案介绍的朋友们,请留言,或者email (lyt2008bj#163.com) 告知我,谢谢。

语法支持


工具 标题 粗体与斜体 列表 引用 图片 链接 表格 代码高亮 分割线
Atom Yes Yes Yes yes yes yes yes yes yes
MarkdownPad2 Yes Yes Yes yes Yes Yes No(付费版才有此功能) No Yes

对于软件Specification,表格和代码高亮是必不可少的,这是最基础的要求。如果能支持流程图,UML图,那就更优了。

易用性


工具 同步预览 md和预览同时滑动 编辑时图片预览 导出类型 显示效果 文件浏览管理
Atom Yes No Yes HTML 可制定 Yes
MarkdownPad2 Yes Yes Yes HTML、PDF 可制定 No

易用性也是非常重要的,因为使用工具的主体是人,易用性关系到生产率。
Atom 一个致命令的不足是,MD内容和预览内容无法实现同时滑动,也有另一个优点那就支持文件管理,满足Specification由多个md文件组成。

其它项


工具 软件类型 收费 扩展性
Atom 开源 免费 插件
MarkdownPad2 商业 付费 样式制定

Atom属于开源,扩展性更优,当属于不二之选。

选型结果


经多个维度的评估,Atom比MarkdownPad2更适合我们的项目,唯一不足是编辑时无法实现同步滑动功能。

向各路朋友高手请教

各位是否有更好的工具推荐,如果有,麻烦请在下面评论,或者发送到我邮箱,谢谢!
如果你对工具很了解,还麻烦帮我将上面的属性信息填好到评论或邮件里,那就真是太感谢了。

另外工程师按每个特性写完一个md文件之后,有什么好的工具, 可以将这些md文件转换成chm文档或者word文档,还请有经验的朋友介绍方法。


推荐阅读
  • CSS3选择器的使用方法详解,提高Web开发效率和精准度
    本文详细介绍了CSS3新增的选择器方法,包括属性选择器的使用。通过CSS3选择器,可以提高Web开发的效率和精准度,使得查找元素更加方便和快捷。同时,本文还对属性选择器的各种用法进行了详细解释,并给出了相应的代码示例。通过学习本文,读者可以更好地掌握CSS3选择器的使用方法,提升自己的Web开发能力。 ... [详细]
  • GetWindowLong函数
    今天在看一个代码里头写了GetWindowLong(hwnd,0),我当时就有点费解,靠,上网搜索函数原型说明,死活找不到第 ... [详细]
  • 生成式对抗网络模型综述摘要生成式对抗网络模型(GAN)是基于深度学习的一种强大的生成模型,可以应用于计算机视觉、自然语言处理、半监督学习等重要领域。生成式对抗网络 ... [详细]
  • 知识图谱——机器大脑中的知识库
    本文介绍了知识图谱在机器大脑中的应用,以及搜索引擎在知识图谱方面的发展。以谷歌知识图谱为例,说明了知识图谱的智能化特点。通过搜索引擎用户可以获取更加智能化的答案,如搜索关键词"Marie Curie",会得到居里夫人的详细信息以及与之相关的历史人物。知识图谱的出现引起了搜索引擎行业的变革,不仅美国的微软必应,中国的百度、搜狗等搜索引擎公司也纷纷推出了自己的知识图谱。 ... [详细]
  • 本文介绍了在Windows环境下如何配置php+apache环境,包括下载php7和apache2.4、安装vc2015运行时环境、启动php7和apache2.4等步骤。希望对需要搭建php7环境的读者有一定的参考价值。摘要长度为169字。 ... [详细]
  • 基于dlib的人脸68特征点提取(眨眼张嘴检测)python版本
    文章目录引言开发环境和库流程设计张嘴和闭眼的检测引言(1)利用Dlib官方训练好的模型“shape_predictor_68_face_landmarks.dat”进行68个点标定 ... [详细]
  • 本文介绍了在MFC下利用C++和MFC的特性动态创建窗口的方法,包括继承现有的MFC类并加以改造、插入工具栏和状态栏对象的声明等。同时还提到了窗口销毁的处理方法。本文详细介绍了实现方法并给出了相关注意事项。 ... [详细]
  • 如何在HTML中获取鼠标的当前位置
    本文介绍了在HTML中获取鼠标当前位置的三种方法,分别是相对于屏幕的位置、相对于窗口的位置以及考虑了页面滚动因素的位置。通过这些方法可以准确获取鼠标的坐标信息。 ... [详细]
  • 在Android开发中,使用Picasso库可以实现对网络图片的等比例缩放。本文介绍了使用Picasso库进行图片缩放的方法,并提供了具体的代码实现。通过获取图片的宽高,计算目标宽度和高度,并创建新图实现等比例缩放。 ... [详细]
  • Nginx使用(server参数配置)
    本文介绍了Nginx的使用,重点讲解了server参数配置,包括端口号、主机名、根目录等内容。同时,还介绍了Nginx的反向代理功能。 ... [详细]
  • 基于layUI的图片上传前预览功能的2种实现方式
    本文介绍了基于layUI的图片上传前预览功能的两种实现方式:一种是使用blob+FileReader,另一种是使用layUI自带的参数。通过选择文件后点击文件名,在页面中间弹窗内预览图片。其中,layUI自带的参数实现了图片预览功能。该功能依赖于layUI的上传模块,并使用了blob和FileReader来读取本地文件并获取图像的base64编码。点击文件名时会执行See()函数。摘要长度为169字。 ... [详细]
  • HDU 2372 El Dorado(DP)的最长上升子序列长度求解方法
    本文介绍了解决HDU 2372 El Dorado问题的一种动态规划方法,通过循环k的方式求解最长上升子序列的长度。具体实现过程包括初始化dp数组、读取数列、计算最长上升子序列长度等步骤。 ... [详细]
  • android listview OnItemClickListener失效原因
    最近在做listview时发现OnItemClickListener失效的问题,经过查找发现是因为button的原因。不仅listitem中存在button会影响OnItemClickListener事件的失效,还会导致单击后listview每个item的背景改变,使得item中的所有有关焦点的事件都失效。本文给出了一个范例来说明这种情况,并提供了解决方法。 ... [详细]
  • 本文介绍了OC学习笔记中的@property和@synthesize,包括属性的定义和合成的使用方法。通过示例代码详细讲解了@property和@synthesize的作用和用法。 ... [详细]
  • 本文介绍了在Linux下安装Perl的步骤,并提供了一个简单的Perl程序示例。同时,还展示了运行该程序的结果。 ... [详细]
author-avatar
小马哥
这个家伙很懒,什么也没留下!
PHP1.CN | 中国最专业的PHP中文社区 | DevBox开发工具箱 | json解析格式化 |PHP资讯 | PHP教程 | 数据库技术 | 服务器技术 | 前端开发技术 | PHP框架 | 开发工具 | 在线工具
Copyright © 1998 - 2020 PHP1.CN. All Rights Reserved | 京公网安备 11010802041100号 | 京ICP备19059560号-4 | PHP1.CN 第一PHP社区 版权所有