盤點Documentation tech stack

因為工作的關係,需要把網路上找得到的公開資訊,尤其是使用文件工具做一些盤點。以下這些公司具體用了什麼工具,以及占比與用途。 在日本待了一段時間,會發現他們的出版社有不同的使命感,比較偏向為了未來而詳細記錄現在曾經發生的事實。因為這些紀錄會散落到各地,必須用實體有形的方式被保存在各地的圖書館或古書店。這樣的行為在中國已經看不見了,可能直到民初還有這樣的風氣。總之這是一種以分散風險的方式,避免事實被當局者抹滅或消除。另一方面,其實這麼做的成本是最低的。

 

進入到1990年代,有更多的資料被抹除了。因為放上網路太簡單,資料的保存變成只剩下三年不到。最近這五年的趨勢是往sns走,在資源有限的情況下有三個優點

  1. 控制輿論
  2. 從匿名用戶的抱怨裡採集可用的改進措施
  3. 推廣本季活動並塑造追蹤者,以及下一季度的推銷活動。

客戶的聲音一直是很重要的,只是在有限的資源整合下,產品或服務平台無法跟上。以下列出來的其實還是一般最終看到的文件呈現模式。所以是by tool的分組方式。

 

純SDL體系 (TCworld China)

從參加者的名單logo裡面可以認出來的硬體電子製造起家的比較多。這也說明了一個產品,比如電動刮鬍刀,如果只要求多語系支援的情況下,SDL的設計確實比較符合內容重用以及翻譯只做翻譯短指令的需求。這部分未來可以善用AI達成,只是產品爆炸圖或組裝還是有人工的繪製和說明需求。這方面不會改變

  • NOKIA
  • Lenovo
  • Bayer
  • REALTEK

Confluence 體系

Netflix 沒有透漏關鍵細節,比較特別是先導入Conflunce才導入Jira。而且似乎是早已有用server版本,才轉用cloud。有提到最舊的文件有15年之久。但Netflix也才17年左右,可以想見當時存的可能是業務需求和一些基本的文件,畢竟早期是做實體dvd租賃的服務起家的。

 

Confluence能成功的關鍵之一是使用的搜尋引擎,只要是第一層或留言曾經出現過的,都能爬到。比起過往沒有寫文件習慣的人,只能選擇在表格內加字或製作投影片。只要直接輸入文字就能產生有價值的歷史資料。缺點是越來越多人沒有專案管理的經驗,所以開了許多空白的標題頁面,或塞滿描述的葉面想企圖用這些連結來管理專案。

 

Atlassian   (用自家的產品,沒什麼好說)

91 app (不明,應該是Google doc,但另外做了開發者專區的網站)

Fuji Xerox (主打OCR,可以把難以重新輸入的舊格式直接掃描入檔進入特定ftp或資料庫


 

混用(論壇混用)

某系統軟體公司  Trac + Confluence + MS visio (製圖) + skype ,直接拒絕使用G doc,雖然沒有外部論壇,但內部直接把開單系統當成論壇用。所以歸類於此。



HTC (htc vive) Confluence + 對外自架forum  

可以看到

 


Qnap: SDL + 自架 forum


Synology : 未知,推測是MS word

 

Spacy 

 

但已經有部分改用線上KB。即使舊的手冊(2012-19)仍有完整的PDF可供直接搜尋。
某博弈集團 Google Docs (api流程製圖 draw.io) + Confluence + Jira + skype + figma(做UI mockup)。


Synology 做的最好,forum和KB整合,還有三種分類:resolved, open, trending

 

類似的還有Bitwarden, 比較差的如Lastpass 。整合式的新世代論壇,是一個較佳的選擇。比如Discourse,當然能支援連動SNS會更好。

 


Mediawiki

Wargaming (world of warships, world of tanks),用心經營戰史和載具資料庫,甚至還做podcast。不過烏俄戰爭開打以後變得很尷尬。

 

 

傳統 Forum 義工為主

  • Mozilla (MDN),最近開始做MDN online 玩付費AI回答了。
  • Ubuntu (早期有ubuntuTW)
  • open SUSE
  • Fedora


 

設備製造業 Mantis + MS visio + illustrator (?)

某金融業公司 MS office + jira + trello

某機器人產業: MS word  (理由是robotic arm產業對於操作說明和安全手冊有硬性規範,必須以紙本形式輸出並列舉具體頁數)

廣明機器人 自架wordpress 

Yasukawa 安川電機 (應該是MS word,但有製作搜尋portal和分類)



總結:

單純以Technical writer來說,隔行如隔山。但還是有跡可循。重點在三個部份的平衡:

  1. Propagation庶民的參與性( 非工程師的意見回報容易程度,可見度、權重)
  2. 正確性(不要求長文,反而短而正確才容易維護)
  3. 美觀 (字體的選用,排版,網頁的樣式不需resize,匯出)

 

尤其第三點其實影響最大,雖然每個人對美感的具體要求不同,但實際上對於美感和舒適其實有著類似的隱藏曲線。舉例來說,操作app的說明用內嵌影片在載入時會受影響,用外嵌又有UI不同的問題。有些人改成用gif動畫,簡短的話在網頁內也還行。

但gif無法在紙本手冊上顯現,超連結也是,這都是忽略了消費內容時的載體和情境。有些人是重度迷因愛好者,居然到處在手冊(Confluence)裡面放了各種gif迷因。 一直到有人終於受不了一些不討喜又不斷重播的惱人gif,直接明白在群組裡說了,他才收斂只在自己的網站裡用。這樣的人其實對於察覺他人的真實心情其實非常差,但做這行其實需要的是這一點。

日本從精緻高貴慢慢走向"專用設計,剛好夠用,預算內勉強,可大量生產複製。

 

大創賣的東西雖然是小物,但其實隱隱抓住了女性顧客的其他需求 (收納箱、糖果、便宜的小孩玩具、驅蟲用品、抓蟲用的飼養箱、防曬用品、便宜保養化妝棉、圖畫冊、時節裝飾品假花春聯假樹枝等、家計簿、堪用3c小物、包裝袋等等)。如果他明白就寫了瞄準女性市場,那麼就得罪了所有人。

 

 

過去許多公司的產品是只要在異國有消費者,一旦建立起使用基礎,只要有負責該語系的翻譯或業務即可。這個階段的文件需求多為"翻譯"

但隨著網路的發達, 多數服務都是透過搜尋和免費註冊試用開始的。這個階段的商業模式則是鼓勵免費試用、有限度免費、進階付費。這時候則是用共通的交流格式,api接口的方式來擴張使用圈。


另一種情況,比較少見,但是最古老也最困難的,是訴諸於美感和蒐集細節正確性。有一些領域比如學術歷史藝術、字體,這樣的通常無法兌換商業價值,所以有一種比例性的連載或分工體系。近代的有浮世繪(漫畫的始祖)、佛壇、印刷術、幾何原本、地圖、字典編撰

 

過去只有王公貴族能享用的,要普及化就必須

  1. 要降低製作成本
  2. 增加庶民娛樂
  3. 不斷連續生產系列作以持續熱潮

這點日本做得很好,比如四驅車這樣小眾的愛好,也能透過動畫製作推動銷量和產業。一直以來也有廣播劇或配音的產業。 還有古本行,一些書道或古文字體普及的愛好者,會用歷史字體和印刷產業的合作來讓這樣的產業有不可取代的價值


公司在找人的時候最好先把自家需求的工具列出來,因為這些工具本身有自己的圈子。它們想擴張到其他行業都有困難,主要是因為還沒有人採用他們。而不是不能採用它們。比如我看過Atlassian曾經宣傳某個礦業公司使用Jira來管理礦場,但那可能是僅有的特例。

 

公司的產品要是偏向獨裁封閉(自家研發,不管顧客想法或市場評價,比如波音客機),那麼SDL那種工法可以。要是必須收集自家開發者或與第三方互動,那麼論壇形式的Confluence比較適合。 這個時代,大多數的產業都需要聽使用者的心聲,所以能收集回饋並加入下一代,會是最好的。

 

其實關鍵還是在於怎麼採集和收集資訊,尤其是能表示"現在狀態"的資訊。隨著時代演進,如果大多數人只是在群組抱怨,那也無法得到現況。所以Atlassian才會在2020年左右開始狂推ITSM,其實就是把helpdesk 弄成開單化,才能留下第一線的回報資料無須再統整。流言有分成

 

經過解答的問題,有一些可以直接加入既有的Knowledge Base,跟Confluence形成一個完整迴圈。不過似乎沒有成功,因為有人的因素在公司裡面作梗。試想如果

如果公司沒辦法從內部凝聚資訊,那就必須以外部sns或其他地方重新收集資訊。從我的經驗,收買重度使用者當傳福音者,或是推行證照化制度其實都不算最好的做法。因為那都只是拿錢假裝有績效的方式,只是對公司內特定使用者有利,對於分辨資訊的品質或提升求職者對公司的貢獻,其實是微乎其微的。如果工具的使用都被掌握了,一切其實都是照著對工具製造者利益長期最大化的情境走。即使選用全套的工具或搭配不同的串起來使用(這裡不特別指程式語言或框架、套裝軟體、驗證體系),也是非常不合身的狀態。為此,必須回到自己的公司,最初究竟是提供什麼樣的商品服務,為了打造那樣的商品服務,應該怎麼使用現有的工具組合,真的不行完成特定關鍵環節流程,就得考慮抽取資料出來,把它訂出規則後打散進原本各自前後段的流程工具內。而不是貿然遷移到另一個服務,認為這樣可以解決問題或節省成本、提升效率。

 

參考資料

https://www.mightynetworks.com/pro/learn/vanilla-forums-vs-discourse

留言