项目文档的分类 项目文档的重要性 常见的误区 写文档是浪费时间？没时间写文档？文档本身也是产出：coding的时间少于30%写文档是整理思路的过程：打字速度应快于思考速度没有...
IP属地：上海
-
技术文档 | 文档对项目的重要性 -
如何为开源项目编写Readme？
什么是Readme？ README（顾名思义：“read me“）是启动新项目时应该阅读的第一个文件。它既包含了一系列关于项目的有用信息又是一个项目的手册。它是别人在 Git...
-
技术文档 | 如何编写对外的发版说明写在前面 在技术文档写作过程中，通常需要技术文档工程师收集并整理汇总产品当前版本中包括什么功能，即，发版说明（又称，ReleaseNotes）,那么应该怎么编写呢？下文根据个...
-
技术文档 | Markdown中的配图写在前面 技术文档中的配图一般分为两种： 流程图 截屏 流程图 流程图一般采用一些额外的工具来绘制，如： graphviz keynote sketch 说明：如果想做出非常...
-
技术文档写作风格指南写在前面 你的产品有多好并不重要。因为如果配上了一份极其敷衍的文档（Documentation），人们就不会使用它。 这话听起来可能有些绝对，毕竟在别无选择的时候，用户或许会...
-
GitBook相关配置及优化
1、GitBook配置说明 1.1、目录结构 1.2、GitBook 特殊文件的功能： 1.3、book.json的配置说明 1.4、Gitbook 默认带有 5 个插件： ...
-
技术文档 | 在 Markdown 中插入图片概述 在写文档时，时常需要向文档中插入图片，以辅助用户理解。因此，图片也是可以很好地补充技术文档的文本。 图片与文字相结合，为用户提供更好的理解和记忆。特别是当用户快速浏览页...
-
产品全生命周期中的技术文档
概述 在产品研发和制造领域，技术文档分为两类： 一类指产品开发中要用到的 研发文档； 一类是面向产品用户的 用户文档。 产品全生命周期 产品全生命周期，大致梳理如下： 在产品...
-
程序员写简历时的技术词汇拼写规范备忘录写在前面 每年这个时候又到了求职的旺季。 求职前，我们都会花很多的时间在自己的技术水平提升+笔/面试的准备之上，但往往却忽略了找工作第一步所需要的一个严谨且靠谱的简历。而程序...
-
产品全生命周期流程图+各阶段输出文档最近项目组在产品开发中遇到了一些项目管理和流程问题，沟通上也存在一些漏洞，产品研发的效率和流畅性都降低了。 于是整理了两张流程图，分别是《产品全生命周期开发流程》和《产品各阶...
-
Github + Markdown 写作环境- 概述[#%E6%A6%82%E8%BF%B0]- Github Desktop[#github-desktop]- Visual Studio Code[#visual-...
-
在 Markdown 中插入视频插入 B 站视频[#%E6%8F%92%E5%85%A5-b-%E7%AB%99%E8%A7%86%E9%A2%91] 插入云上对象存储中的视频[#%E6%8F%92%E5%...
-
统计多个 Markdown 文件的总字数打开需要统计字数的文档项目所在的文件夹目录。 打开终端，此处使用的是git shell工具。git shell 工具 在该终端中输入命令find . -name '*.jso...
-
-
技术传播|tcworld2021 Day1小记当当当，好久不见，季更选手来更新啦！ 我一个人在上海，来参加技术传播专业会tcworld2021。简要记录一下参会第一天的收获和感受。 武功秘籍在哪里？ 我目前工作所面临的最...
-
Markdown 基本语法
比较全面且易懂的 Markdown 基本语法，可参见 Markdown 基本语法[https://markdown.com.cn/basic-syntax/]。
-
多个 Markdown 导出为 PDF使用 gitbook 将多个 Markdown 导出为一本电子书的形式 PDF。 安装 NodeJS 在 windows 下安装 NodeJS，可参见 安装步骤[https:...
-
单个 Markdown 导出为 PDF在 VSCode 编辑器的扩展（Ctrl+Shift+X）中，安装“Markdown PDF”扩展。Markdown扩展 安装完成后，打开需要导出 PDF 的 Markdow...
