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

用markdown文档完全替代word文档的可行性

目前公司正在讨论后续文档管理的策略,在方案选型的时候,在word和markdown之间有些犹豫。主要是分析了现有文档管理情况,然后考虑新项目的文档如何管理。大致情况如下:

目前公司正在讨论后续文档管理的策略,在方案选型的时候,在 word 和 markdown 之间有些犹豫。

主要是分析了现有文档管理情况,然后考虑新项目的文档如何管理。大致情况如下:
1.硬件团队的嵌入式的代码直接使用文本文件的 README,甚至用 ASCII 化简图(有非常 nb 的老工程师在驱动代码文件头部用 ASCII 拼除了芯片引脚和寄存器移位的示意图,这种只能膜拜,绝壁是不能动的)。
2.软件团队内部主要使用 Sphinx,部分 java 代码相关的用 javadoc。
3.系统架构、需求方面以 word 文档为主,有不少内嵌的 UML 截图,visio 截图。
4.测试文档也是用的 word 编写,测试用例主要是 excel 模板管理,测试报告也是 excel 套 word 模板生成的,一边测一边填 excel,测完运行一个宏直接生成。
5.用户手册也是用的 Word 模板,然后人工编写。
6.各个部门内部有一些比较好的经验分享类的文章,也是用 word 编制的,很多都是图文并茂。

现在的主要问题是这些文档都是独立的文档,公司想把这些文档做成某种能够在线检索的知识库,同时还要考虑以下问题:
1,去微软化,彻底替换 word,而且不考虑 WPS,文档格式需要能够完全透明,根据自己的需要检索、解析或者批量处理,能用 git 进行版本管理。
2,显示输出要保持同类型 word 文档的层次和条目,不能跟以前老项目的文档看起来有很大不同,细微的差别可以接受。
3,必须能够像 word 那样在 A4 纸上分页打印输出,同时如果在线查看也能像 HTML 那样连续输出一整篇。
4,能够导出成 pdf 作为离线的电子版发布。
5,一篇文章作为一个文件,图片必须内嵌到文章里,不能以链接的方式单独存放。
6,支持离线编辑,支持图文混和编辑,所见即所得。

我已经在 word 上面做了大量尝试,包括使用 sharepoint 来进行版本管理,这套方案还是太厚重了,sharepoint 的版本管理和 git 还不太一样。另外在网上看见有方案是用 BASE64 编码图片然后内嵌到 markdown 文档里面,不知道较大的图片是否可行。文档格式方面其实没有特别复杂的需求,刚性的主要是图文混排,分段,加粗加黑,缩进这些,word 和 wps 的格式其实已经太复杂了,很多功能用不上。

大家有没有其他好的实践,希望能分享一下。

要不试试语雀?


推荐阅读
  • 用户登录 ... [详细]
  • 微软头条实习生分享深度学习自学指南
    本文介绍了一位微软头条实习生自学深度学习的经验分享,包括学习资源推荐、重要基础知识的学习要点等。作者强调了学好Python和数学基础的重要性,并提供了一些建议。 ... [详细]
  • 转自:http:www.phpweblog.netfuyongjiearchive200903116374.html一直对字符的各种编码方式懵懵懂懂,什 ... [详细]
  • 云原生边缘计算之KubeEdge简介及功能特点
    本文介绍了云原生边缘计算中的KubeEdge系统,该系统是一个开源系统,用于将容器化应用程序编排功能扩展到Edge的主机。它基于Kubernetes构建,并为网络应用程序提供基础架构支持。同时,KubeEdge具有离线模式、基于Kubernetes的节点、群集、应用程序和设备管理、资源优化等特点。此外,KubeEdge还支持跨平台工作,在私有、公共和混合云中都可以运行。同时,KubeEdge还提供数据管理和数据分析管道引擎的支持。最后,本文还介绍了KubeEdge系统生成证书的方法。 ... [详细]
  • 本文介绍了C#中数据集DataSet对象的使用及相关方法详解,包括DataSet对象的概述、与数据关系对象的互联、Rows集合和Columns集合的组成,以及DataSet对象常用的方法之一——Merge方法的使用。通过本文的阅读,读者可以了解到DataSet对象在C#中的重要性和使用方法。 ... [详细]
  • [译]技术公司十年经验的职场生涯回顾
    本文是一位在技术公司工作十年的职场人士对自己职业生涯的总结回顾。她的职业规划与众不同,令人深思又有趣。其中涉及到的内容有机器学习、创新创业以及引用了女性主义者在TED演讲中的部分讲义。文章表达了对职业生涯的愿望和希望,认为人类有能力不断改善自己。 ... [详细]
  • 本文介绍了Linux系统中正则表达式的基础知识,包括正则表达式的简介、字符分类、普通字符和元字符的区别,以及在学习过程中需要注意的事项。同时提醒读者要注意正则表达式与通配符的区别,并给出了使用正则表达式时的一些建议。本文适合初学者了解Linux系统中的正则表达式,并提供了学习的参考资料。 ... [详细]
  • FeatureRequestIsyourfeaturerequestrelatedtoaproblem?Please ... [详细]
  • CentOS 7部署KVM虚拟化环境之一架构介绍
    本文介绍了CentOS 7部署KVM虚拟化环境的架构,详细解释了虚拟化技术的概念和原理,包括全虚拟化和半虚拟化。同时介绍了虚拟机的概念和虚拟化软件的作用。 ... [详细]
  • Week04面向对象设计与继承学习总结及作业要求
    本文总结了Week04面向对象设计与继承的重要知识点,包括对象、类、封装性、静态属性、静态方法、重载、继承和多态等。同时,还介绍了私有构造函数在类外部无法被调用、static不能访问非静态属性以及该类实例可以共享类里的static属性等内容。此外,还提到了作业要求,包括讲述一个在网上商城购物或在班级博客进行学习的故事,并使用Markdown的加粗标记和语句块标记标注关键名词和动词。最后,还提到了参考资料中关于UML类图如何绘制的范例。 ... [详细]
  • java io换行符_Java IO:为什么从stdin读取时,换行符的数字表示出现在控制台上?...
    只是为了更好地理解我在讲座中听到的内容(关于Java输入和输出流),我自己做了这个小程序:publicstaticvoidmain(String[]args)thro ... [详细]
  • 【blockly教程】第五章 循环结构
    在这里,我们将介绍一个新游戏--PondTutor在PondTutor(https:blockly-games.appspot.compond-tutor)这个游戏中 ... [详细]
  • RMarkdown是一种用于在R中生成可重复生成的报告的开源工具。它可以帮助您将所有代码,结果和编写都放在一个地方,并以有吸引力且易于消化的方式格式化所 ... [详细]
  • MarkDown编辑器Zettlr for mac
    Zettlrmac版是一款功能强大的MarkDown编辑器,ZettlrZettlr具有简洁简洁的设计,在无干扰的模式下使您可以专注于实际书写ÿ ... [详细]
  • 设计模式那点事读书笔记(3)建造者模式
    建造者模式:建造者模式是将复杂的对象构造进行分离,使得每个部件完成比较独立的工作.通过抽象类,接口来约束建造的过程.解决什么问题:当生成的产品对象内部具有复杂的结构.当复杂对象需要 ... [详细]
author-avatar
手机用户2502928341
这个家伙很懒,什么也没留下!
PHP1.CN | 中国最专业的PHP中文社区 | DevBox开发工具箱 | json解析格式化 |PHP资讯 | PHP教程 | 数据库技术 | 服务器技术 | 前端开发技术 | PHP框架 | 开发工具 | 在线工具
Copyright © 1998 - 2020 PHP1.CN. All Rights Reserved | 京公网安备 11010802041100号 | 京ICP备19059560号-4 | PHP1.CN 第一PHP社区 版权所有