文件開發工具調研總結

2021-09-30 17:34:56 字數 1544 閱讀 2939

工具清單

文件開發工具調研:

工具型別

標記語法

工具支援平台

原始檔形式

交付形式

是否支援文件組織

發布對中文的支援

說明使用者

非標記類

word

office word

window、mac

docx、doc

word、pdf是支援

無使用門檻,但需要花時間在格式處理上

各公司標記語言類

markdown

gitbook

window、linuxmd是

支援由於使用markdow語法,對複雜格式(如複雜**、標題)等支援不足。

原始檔可託管在gitbook或github上,可將文件發布到指定網域名稱下。gitbook本身不提供版本控制,而且客戶端工具使用體驗較差。

微軟azure的所有文件採用markdown並託管在github上

showdoc

基於瀏覽器,平台無關md是

支援主要用於多人協作開發介面文件、資料字典文件等,但不能匯出到本地,原始檔在服務端(支援雲模式和私有伺服器模式)。

小型的網際網路公司

typora+pandoc

window

mdmd、html、pdf、word

支援,但缺少導航

通過pandoc命令匯出中文(支援指定語言屬性),但依然會有亂碼

typora原生僅支援md格式,通過pandoc可以實各種格式之間的轉換

無相關資料

restructuredtext 

sphinx

linux

rsthtml、manual pages(man 文件)、latex(可列印pdf)是支援

相比markdown支援更多的格式,但目前用於python專案

asciidoctor

asciidockor

linux

adoc

pdf、本地html

是未測試

安裝過程較麻煩。命令式管理,可以使用linux上的各文字編輯器進行內容寫作。

語法與markdow型別,但支援更複雜的格式控制。

redhat, transwrap, openstack, citrusframework

asciidocfx

window/linux/mac

adoc

pdf、本地html、epub、mobi

是可以指定語言屬性

易安裝和使用,可以快速上手。

無相關資料

需求:1、支援文件組織;2、支援pdf格式和html格式;3、匯出的html與pdf需要支援導航

結論:通過對各工具比較,asciidocfx能滿足上述需求。

其它說明:在樣式控制上,基於標記類語言的工具都是要弱於word的。在支援window的工具中,有gitbook和asciidocfx,但gitbook是在github託管的,而且不能提供本地的html;相對而言,asciidocfx比較滿足我們的需求,語法簡單,支援pdf以及本地html,同時可以構建出結構良好的導航。

需求文件開發工具推薦

visio 將業務,從產品層面肢解開來,做到抽絲剝繭部分與整體統一 mindmanage 把專案條目化,條理化,目錄結構具體規定好 axure 前台結構布局,合理規範的將系統說明白 官方 www.axure.com 解壓密碼 www.portablesoft.org 壓縮包md5 ff338e3a5...

Xilinx FPGA開發工具總結

在xilinx下每種操作其實都對應著一種工具,邏輯綜合,網表與constraint fie的合併,布局佈線等等。下面就對各個工具做乙個總結。1,xst xilinx synthesis technology 是xilinx退出的邏輯語言綜合工具,它所做的就是把hdl語言表述的邏輯綜合成特定的網表檔案...

開發工具總結 規範工具 jekins

1 工欲善其事必先利其器 notepad 可以進行編碼格式轉換,正規表示式,nppastyle外掛程式 格式化等 sourceinsight4.0 支援utf8,tab替換4空格,對齊方式,智慧型替換,astyle外掛程式 格式化,各種快捷命令等。astyle外掛程式 我常用astyle confi...