項(xiàng)目文檔的分類 項(xiàng)目文檔的重要性 常見的誤區(qū) 寫文檔是浪費(fèi)時(shí)間？沒時(shí)間寫文檔？文檔本身也是產(chǎn)出：coding的時(shí)間少于30%寫文檔是整理思路的過程：打字速度應(yīng)快于思考速度沒有...
IP屬地：上海
-
技術(shù)文檔 | 文檔對(duì)項(xiàng)目的重要性 -
如何為開源項(xiàng)目編寫Readme？
什么是Readme？ README（顧名思義：“read me“）是啟動(dòng)新項(xiàng)目時(shí)應(yīng)該閱讀的第一個(gè)文件。它既包含了一系列關(guān)于項(xiàng)目的有用信息又是一個(gè)項(xiàng)目的手冊(cè)。它是別人在 Git...
-
技術(shù)文檔 | 如何編寫對(duì)外的發(fā)版說明寫在前面 在技術(shù)文檔寫作過程中，通常需要技術(shù)文檔工程師收集并整理匯總產(chǎn)品當(dāng)前版本中包括什么功能，即，發(fā)版說明（又稱，ReleaseNotes）,那么應(yīng)該怎么編寫呢？下文根據(jù)個(gè)...
-
技術(shù)文檔 | Markdown中的配圖寫在前面 技術(shù)文檔中的配圖一般分為兩種： 流程圖 截屏 流程圖 流程圖一般采用一些額外的工具來繪制，如： graphviz keynote sketch 說明：如果想做出非常...
-
嵌入式工程師，創(chuàng)客愛好者，公眾號(hào)：美男子玩編程，全網(wǎng)粉絲10萬+，軟著專利10余項(xiàng)。<br>CSDN博客專家、微軟MVP、華為云云享專家、阿里云專家博主、知乎認(rèn)證科學(xué)技術(shù)領(lǐng)域答主。
-
技術(shù)文檔寫作風(fēng)格指南寫在前面 你的產(chǎn)品有多好并不重要。因?yàn)槿绻渖狭艘环輼O其敷衍的文檔（Documentation），人們就不會(huì)使用它。 這話聽起來可能有些絕對(duì)，畢竟在別無選擇的時(shí)候，用戶或許會(huì)...
-
GitBook相關(guān)配置及優(yōu)化
1、GitBook配置說明 1.1、目錄結(jié)構(gòu) 1.2、GitBook 特殊文件的功能： 1.3、book.json的配置說明 1.4、Gitbook 默認(rèn)帶有 5 個(gè)插件： ...
-
技術(shù)文檔 | 在 Markdown 中插入圖片概述 在寫文檔時(shí)，時(shí)常需要向文檔中插入圖片，以輔助用戶理解。因此，圖片也是可以很好地補(bǔ)充技術(shù)文檔的文本。 圖片與文字相結(jié)合，為用戶提供更好的理解和記憶。特別是當(dāng)用戶快速瀏覽頁...
-
產(chǎn)品全生命周期中的技術(shù)文檔
概述 在產(chǎn)品研發(fā)和制造領(lǐng)域，技術(shù)文檔分為兩類： 一類指產(chǎn)品開發(fā)中要用到的 研發(fā)文檔； 一類是面向產(chǎn)品用戶的 用戶文檔。 產(chǎn)品全生命周期 產(chǎn)品全生命周期，大致梳理如下： 在產(chǎn)品...
-
程序員寫簡(jiǎn)歷時(shí)的技術(shù)詞匯拼寫規(guī)范備忘錄寫在前面 每年這個(gè)時(shí)候又到了求職的旺季。 求職前，我們都會(huì)花很多的時(shí)間在自己的技術(shù)水平提升+筆/面試的準(zhǔn)備之上，但往往卻忽略了找工作第一步所需要的一個(gè)嚴(yán)謹(jǐn)且靠譜的簡(jiǎn)歷。而程序...
-
產(chǎn)品全生命周期流程圖+各階段輸出文檔最近項(xiàng)目組在產(chǎn)品開發(fā)中遇到了一些項(xiàng)目管理和流程問題，溝通上也存在一些漏洞，產(chǎn)品研發(fā)的效率和流暢性都降低了。 于是整理了兩張流程圖，分別是《產(chǎn)品全生命周期開發(fā)流程》和《產(chǎn)品各階...
-
Github + Markdown 寫作環(huán)境- 概述[#%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] 插入云上對(duì)象存儲(chǔ)中的視頻[#%E6%8F%92%E5%...
-
統(tǒng)計(jì)多個(gè) Markdown 文件的總字?jǐn)?shù)打開需要統(tǒng)計(jì)字?jǐn)?shù)的文檔項(xiàng)目所在的文件夾目錄。 打開終端，此處使用的是git shell工具。git shell 工具 在該終端中輸入命令find . -name '*.jso...
-
Markdown 基本語法
比較全面且易懂的 Markdown 基本語法，可參見 Markdown 基本語法[https://markdown.com.cn/basic-syntax/]。
-
多個(gè) Markdown 導(dǎo)出為 PDF使用 gitbook 將多個(gè) Markdown 導(dǎo)出為一本電子書的形式 PDF。 安裝 NodeJS 在 windows 下安裝 NodeJS，可參見 安裝步驟[https:...
-
單個(gè) Markdown 導(dǎo)出為 PDF在 VSCode 編輯器的擴(kuò)展（Ctrl+Shift+X）中，安裝“Markdown PDF”擴(kuò)展。Markdown擴(kuò)展 安裝完成后，打開需要導(dǎo)出 PDF 的 Markdow...
-
產(chǎn)品經(jīng)理必備文檔之【PMP項(xiàng)目管理文檔】一、三種工具 溝通工具、管理工具、備忘工具 二、項(xiàng)目文檔的玩法 1、定義模板 【1】定義格式，固化進(jìn)本要素。 【2】分類清晰，機(jī)構(gòu)化，邏輯化。 【3】版本管理，及時(shí)通報(bào)變更。...
-
簡(jiǎn)單6步教你如何搭建內(nèi)容社區(qū)這篇文章想給大家介紹一下內(nèi)容社區(qū)的搭建過程。不同的內(nèi)容社區(qū)在產(chǎn)品形態(tài)和運(yùn)營手段上可能會(huì)有一些不同，但是發(fā)展過程會(huì)有一些共性，產(chǎn)品的功能也會(huì)有很大的相似性。 1、確定用戶群和內(nèi)...
