寫(xiě)在前面 你的產(chǎn)品有多好并不重要。因?yàn)槿绻渖狭艘环輼O其敷衍的文檔（Documentation）噩凹，人們就不會(huì)使用它临扮。 這話聽(tīng)起來(lái)可能有些絕對(duì)，畢竟在別無(wú)選擇的時(shí)候剃允，用戶(hù)或許會(huì)...
IP屬地：上海
-
技術(shù)文檔寫(xiě)作風(fēng)格指南 -
GitBook相關(guān)配置及優(yōu)化
1沛简、GitBook配置說(shuō)明 1.1、目錄結(jié)構(gòu) 1.2斥废、GitBook 特殊文件的功能： 1.3椒楣、book.json的配置說(shuō)明 1.4、Gitbook 默認(rèn)帶有 5 個(gè)插件： ...
-
技術(shù)文檔 | 在 Markdown 中插入圖片概述 在寫(xiě)文檔時(shí)牡肉，時(shí)常需要向文檔中插入圖片捧灰，以輔助用戶(hù)理解。因此统锤，圖片也是可以很好地補(bǔ)充技術(shù)文檔的文本毛俏。 圖片與文字相結(jié)合炭庙，為用戶(hù)提供更好的理解和記憶。特別是當(dāng)用戶(hù)快速瀏覽頁(yè)...
-
產(chǎn)品全生命周期中的技術(shù)文檔
概述 在產(chǎn)品研發(fā)和制造領(lǐng)域煌寇，技術(shù)文檔分為兩類(lèi)： 一類(lèi)指產(chǎn)品開(kāi)發(fā)中要用到的 研發(fā)文檔焕蹄； 一類(lèi)是面向產(chǎn)品用戶(hù)的 用戶(hù)文檔。 產(chǎn)品全生命周期 產(chǎn)品全生命周期阀溶，大致梳理如下： 在產(chǎn)品...
-
程序員寫(xiě)簡(jiǎn)歷時(shí)的技術(shù)詞匯拼寫(xiě)規(guī)范備忘錄寫(xiě)在前面 每年這個(gè)時(shí)候又到了求職的旺季腻脏。 求職前，我們都會(huì)花很多的時(shí)間在自己的技術(shù)水平提升+筆/面試的準(zhǔn)備之上银锻，但往往卻忽略了找工作第一步所需要的一個(gè)嚴(yán)謹(jǐn)且靠譜的簡(jiǎn)歷迹卢。而程序...
-
產(chǎn)品全生命周期流程圖+各階段輸出文檔最近項(xiàng)目組在產(chǎn)品開(kāi)發(fā)中遇到了一些項(xiàng)目管理和流程問(wèn)題，溝通上也存在一些漏洞徒仓，產(chǎn)品研發(fā)的效率和流暢性都降低了腐碱。 于是整理了兩張流程圖，分別是《產(chǎn)品全生命周期開(kāi)發(fā)流程》和《產(chǎn)品各階...
-
在 Markdown 中插入視頻插入 B 站視頻[#%E6%8F%92%E5%85%A5-b-%E7%AB%99%E8%A7%86%E9%A2%91] 插入云上對(duì)象存儲(chǔ)中的視頻[#%E6%8F%92%E5%...
-
Github + Markdown 寫(xiě)作環(huán)境- 概述[#%E6%A6%82%E8%BF%B0]- Github Desktop[#github-desktop]- Visual Studio Code[#visual-...
-
統(tǒng)計(jì)多個(gè) Markdown 文件的總字?jǐn)?shù)打開(kāi)需要統(tǒng)計(jì)字?jǐn)?shù)的文檔項(xiàng)目所在的文件夾目錄掉弛。 打開(kāi)終端症见，此處使用的是git shell工具。git shell 工具 在該終端中輸入命令find . -name '*.jso...
