文档写作利器：Markdown

大佬的文章,写的很好,里面推荐的Markdown编辑工具很不错,值的推荐. 文档写作利器:Markdown_网络_xcbeyond|疯狂源自梦想,技术成就辉煌-CSDN博客https://blog.csdn.net/xcbeyond/article/details/104303577?utm_source=app…

layout: postcategory: javatitle: 入坑 docsify,一款神奇的文档生成利器!tagline: by 沉默王二tags: - java Guide 哥是我认识的一个非常优秀的年轻人,胖嘟嘟的身躯里充斥着无穷无尽的才华,他的 JavaGuide 在 GitHub 上已经标星 91K+ 了,空闲的时候我都会上去瞅两眼,毕竟学习使我快乐,嘿嘿. 有一天,我发现,他整的那个在线版看起来非常漂亮,我就问他用什么做的,他就会回我说,"docsify,很方便."刚好…

产品需求文档写作方法（三）用例文档(UML用例图、流程图)

在产品和技术领域里都有UML的技能知识,而对于产品人员的UML则更多的是指用例图,也就是我所称呼的用户流程图.在讲PRD文档写作的第二篇文章里,我提到了用户流程图的制作,实际上用户流程图是我在产品规则的初期对用例图的一种结构化的表达方式,由于以结构化的方式描述用例太抽象,缺少逻辑性表达,并且那篇文章更偏向于功能性用户流程,还不是实际意义上的用例,因此今天我补文一篇,细讲一下UML用例图和用例文档. 用例文档是由多个用例组成的一份文档,主要用于技术开发与测试使用,他是PRD中的重要辅助文档,用于讲…

Element 文档中的 Markdown 解析

Element 的文档站是讲Markdown解析成vue组件在页面中渲染出来,转换过程如下图所示: 红框部分势必要对 Markdown 进行特殊的订制,订制过的 Markdown 像下面这样. :::demo 要使用 Radio 组件,只需要设置`v-model`绑定变量,选中意味着变量的值为相应 Radio `label`属性的值,`label`可以是`String`.`Number`或`Boolean`. ```html <template> <el-radio v-model=…

小胖求学系列之-文档生成利器(下)-smart-doc

叮叮叮....一阵铃声响起,大家都陆续来到了课堂,看老师没来,小张和小胖又闲聊起来,小张问:怎么样,smart-doc好用吧.小胖笑着说:挺好用的,不过? 小张看卖关子,问到:不过什么,有什么新发现?小胖说:我在试用了这个之后,发现还能进一步简化,大家在用这个的时候,更多的是关心能不能快速帮我生成文档,没人想写那一套模版代码.小张说:你说的也有道理,那你有什么好办法.小胖说:可以借助maven自定义插件,把生成文档的模版代码全部隐藏起来,让大家只需要引入这个插件,需要生成文档的时候,点一下按钮就…

小胖求学系列之-文档生成利器(上)-smart-doc

最近小胖上课总是挂着黑眼圈,同桌小张问:你昨晚通宵啦?小胖有气无力的说到:最近开发的项目接口文档没写,昨晚补文档补了很久,哎,昨晚只睡了2个小时.小张说:不是有生成文档工具吗,类似swagger2.smart-doc之类的,你咋不用呢.小胖说:swagger2我倒听过,有一些入行门槛,且对业务代码有侵入性,smart-doc没听过,这玩意好用吗?小张说:smart-doc几乎没有入行门槛,我最近一直在用,有没有感觉我最近工作效率变高了.小胖说:对啊,这货有啥魔法吗,可以不需要学习的情况下,帮助你…

ShowDoc 软件开发团队接口文档管理利器

ShowDoc是一个非常适合IT团队的在线API文档.技术文档工具.你可以使用Showdoc来编写在线API文档.技术文档.数据字典.在线手册. 这里介绍 Showdoc 这款开源(免费)文档管理系统, 可以部署企业内部, 后台使用 php + sqlite, 支持 Windows/Linux/Docker 部署形式. showdoc 的功能:1. 文档编辑语法采用 markdown, 编辑器做的挺不错. 2. 支持文档版本管理3. 可以将文档导出为 word 软件格式4. 权限控制: 可以新建…