本文介紹我用過的工具。
Authoring Tools
| 工具名 | 優(yōu)點 | 缺點 |
|---|---|---|
| MS Word | - 大眾軟件，群眾基礎廣 | - 樣式不穩(wěn)定，極易產生派生樣式 - 應用樣式時，容易出現無法預知的錯誤 - 大文檔生成PDF時耗時很長 |
| Acrobat FrameMaker | - 專業(yè)Authoring Tool - 樣式穩(wěn)定 - 便于多個writer協同合作 - 提供inset功能便于內容重用 - 生成PDF流暢 | - 審閱者一般沒有安裝該工具，必須生成PDF送審 (解決方法：Writer可用Abode Professional 將PDF轉成WORD；或生成PDF時，啟用“Read Commenting Enabled”） |
| XML Authoring Tool such as OxyGen | * 適于內容重用度高的文檔 ； * 文檔樣式可根據CSS設定靈活呈現 * 支持生成各種輸出格式 （html, PDF) * 最后，通過Information architect預先設定每類Topic的必需元素，可以做到通過工具，保證不同writer在topic上寫作風格統(tǒng)一，不遺失Topic中的任何必需元素。我認為它是Topic-based writing實現的一個利器。 | - 用Acrolinx做語法檢查時，必須一個個dita file檢查，有些費力 - 寫作編輯時看到的是很單調的近乎txt的文本，視覺效果不好 - 需要有經驗的writer來定制與維護樣式 |
| ClickHelp云寫作與發(fā)布平臺 | 寫作、版本管理、發(fā)布多功能云寫作平臺。 | 部署在云端，訪問速度取決于網絡連接。 |
| Adobe Robohelp | - 在線文件寫作與生成工具 - 支持Word與FM file倒入 - 自定義skin, cover... | - 需要有經驗的writer來定制與維護樣式庫 |
| Help & Manual | - 在線文件寫作與生成工具 - 支持Word與FM file倒入 - 自定義skin, cover, 可導出各種樣式，導出的WORD，需要自定制模板，且樣式不理想 | - 需要有經驗的writer來定制與維護樣式庫 |
| Atlassian Confluence | - 共享式文檔開發(fā)平臺；- 支持Word、Excel文件導入 - 可輸出業(yè)內通用各種文檔樣式 - 可生成HTML文件從而與當下流行的File Server文檔發(fā)布模式契合 - 豐富的第三方插件 （例如可購Workflow插件從而streamline整個寫作審閱/編輯/發(fā)布流程）- 可通過CSS文件自定義樣式 | - 可查看Revision History, 但沒有自帶版本管理 (需購插件）- 需要有經驗的writer來定制與維護樣式 |
| Markdown | - 網頁文檔寫作工具 （多用于軟件類產品文檔）最進接觸到。- 使用markdown工具編寫文檔，通過靜態(tài)網站生成工具生成網頁文檔 （如需了解相關工具，可在“知H”搜索<軟件技術文檔代碼化現象>一文 | - Markdown對于寫簡書的朋友應該不會陌生。我在使用過程中有不少格式上的困惑，比如表格中的bulleted point如何解決...聽說過通過coding可以解決。但還沒有實踐過。- WYSIWYG功能差些，雖然可以開即時顯示窗口。 |
Confluence文檔host在服務器上，若無版本管理插件，無法實現版本管理。上表中其它工具都可利用公司現有的代碼管理軟件，實現版本管理。MA代碼管理工具使用的是Perforce， UT使用的是Clearcase。
Diagramming Tools
- SnagIt--截圖工具，可修圖。
- MS Visio--流程圖與組網圖繪制工具?？勺远x與加載 stencils（類似于圖庫）。
- Greenshot--開源截圖工具
- Draw.io--開源類Visio畫圖工具 （具體下載與說明，見【資源共享】沒有Visio？試試這些開源或常用工具)
說明：Visio可將圖片存在SNG格式，該格式圖片中的文本信息支持全文搜索。(2007以上版本Visio可直接支持，2007版需做一個小設置，網上可搜到方法）
PDF編輯工具
- Adobe Acrobat Professional -- 可編輯PDF文件，可把FM, Word文檔輸出成PDF。在審閱時，支持把PDF文件放在File Server上，發(fā)起共享式評審。
- Foxit 福祈-- 使用的是免費版，雖遠沒有Professional強大，但比Acrobat Reader強太多。
語法與寫作樣式檢查工具
Acrolinx -- 可做語法與自定寫作規(guī)則定義，但價格有些貴。不過保證了文檔寫作的風格，大大提高協同文檔的一致性。
MA文檔發(fā)布形式
- PDFs published on Moody's Analytics Support Web
- Online help embedded in the RO S/W
- HTML Documents hosted on the MA Portal File Server
MA 寫作規(guī)范
- Writing Style Guide
- Graphic Style Guide
- Trademark Guidelines
