美文网首页
技术文档 | Markdown中的配图

技术文档 | Markdown中的配图

作者: UU5Xin | 来源:发表于2022-05-07 10:36 被阅读0次

写在前面

技术文档中的配图一般分为两种:

  • 流程图
  • 截屏

流程图

流程图一般采用一些额外的工具来绘制,如:

  • graphviz
  • keynote
  • sketch
流程图样例.png

说明:

如果想做出非常专业的配图,需保证

  • 字形/字体:大小,粗细的变化
  • 颜色:基本的配色理论就可以做出很舒服的配色
  • 层次:尺寸,位置,颜色的深浅

截屏

截屏通常使用系统自带的截图工具截取所需要的产品界面就已经足够。

  • 如果图片上加文字时,尽量从图片中吸取一个恰当的颜色。
  • 如果截好屏的图片如果太大,最好将图片压缩一下(可以使用TinyPNG工具)再上传,这样一方面可以使网页速度加载得快些,另一方面可以降低CDN和用户流量费用。

注意:
截取的图片需要经过脱敏后方可插入文档中,一般如下情况需要脱敏:

  • 涉及客户和项目的名称
  • 涉及公司机密的信息
  • 涉及同事的信息
  • 涉及所有用文字和图片的版权信息

写在后面

常见配图的存放位置,请参见《技术文档 | 在 Markdown 中插入图片》

相关文章

  • 技术文档 | Markdown中的配图

    写在前面 技术文档中的配图一般分为两种: 流程图 截屏 流程图 流程图一般采用一些额外的工具来绘制,如: grap...

  • 在VS Code中编辑Markdown文档

    上节《用Markdown撰写IT技术文档、博客和电子书》讲述了为什么要用Markdown撰写技术文档,以及使...

  • 如何写好项目文档

    一、项目文档的重要性 二、文档书写规范 三、文档内容的书写 四、文档中的配图 五、如何提高写文档的能力

  • 技术文档 | 在 Markdown 中插入图片

    概述 在写文档时,时常需要向文档中插入图片,以辅助用户理解。因此,图片也是可以很好地补充技术文档的文本。 图片与文...

  • 如何使用Markdown撰写技术文档

    本文不涉及具体的 Markdown 语法教学 本文主要介绍在使用 Markdown 语法来进行技术文档写作时,如何...

  • 一次编写,到处粘贴

    平时写作,无论是写生活游记还是技术文档,都喜欢用markdown,markdown也确实方便好用。在用markdo...

  • 在Hexo中渲染MathJax数学公式

    在Hexo中渲染MathJax数学公式 在用markdown写技术文档时,免不了会碰到数学公式。常用的Markdo...

  • Markdown学习笔记

    Markdown基本用法 总览 这是我第一篇 MarkDown*编写的文档。Markdown中#号表示标题,##表...

  • 七牛+Automator构建简单快捷的文件上传系统

    问题来由 自从决定用Markdown写教程和技术文档,就很快遇到了插入图片的问题,因为Markdown需要用图片链...

  • Markdown 自我学习教程

    前提 由于有的时候需要编写技术需求文档、使用文档、测试文档,又加上最近使用Markdown比较多,所以积累了一些经...

网友评论

      本文标题:技术文档 | Markdown中的配图

      本文链接:https://www.haomeiwen.com/subject/eniturtx.html