项目文档的分类 项目文档的重要性 常见的误区 写文档是浪费时间?没时间写文档?文档本身也是产出:coding的时间少于30%写文档是整理思路的过...
什么是Readme? README(顾名思义:“read me“)是启动新项目时应该阅读的第一个文件。它既包含了一系列关于项目的有用信息又是一个...
写在前面 在技术文档写作过程中,通常需要技术文档工程师收集并整理汇总产品当前版本中包括什么功能,即,发版说明(又称,ReleaseNotes),...
写在前面 技术文档中的配图一般分为两种: 流程图 截屏 流程图 流程图一般采用一些额外的工具来绘制,如: graphviz keynote sk...
写在前面 你的产品有多好并不重要。因为如果配上了一份极其敷衍的文档(Documentation),人们就不会使用它。 这话听起来可能有些绝对,毕...
概述 在写文档时,时常需要向文档中插入图片,以辅助用户理解。因此,图片也是可以很好地补充技术文档的文本。 图片与文字相结合,为用户提供更好的理解...
概述 在产品研发和制造领域,技术文档分为两类: 一类指产品开发中要用到的 研发文档; 一类是面向产品用户的 用户文档。 产品全生命周期 产品全生...
- 概述[#%E6%A6%82%E8%BF%B0]- Github Desktop[#github-desktop]- Visual Studi...
插入 B 站视频[#%E6%8F%92%E5%85%A5-b-%E7%AB%99%E8%A7%86%E9%A2%91] 插入云上对象存储中的视频...