公司犯關於技術文獻的名列前茅五個錯誤
我看見了它反覆。我在工程學公司的確中看了的最共同的弱點的當中一個, 一幾乎普遍缺點是缺乏適當的技術文獻。一些對這一笑了之作為較小細節; 但是, 反映經常是嚴厲的。公司的整個未來可能被做或丟失根據他們給予對這個問題的相當數量注意。
多年來, 我辨認了我發現是特別共同的五個問題當它來到文字技術文獻。我希望與您分享這些想法, 希望防止其他人跌倒同樣道路。
1 。有任何用戶手冊
不要笑。這也許似乎像一相當基本差錯荒謬, 均勻但它是驚奇共同。我遇到了為他們的產品不提供用戶手冊, 或指南是skeletally 稀薄或幾年過時的許多公司。實際上, 我會估計大約我遇到了歸入這個類別小工程學公司的半。(當然, 你很少遇到這個問題當買現成的軟體或家電。在工程師之中雖則, 這是一個depressingly 熟悉的故事。)
我記住怎麼一位工程師告訴了我為什麼他的公司沒有提供任何用戶手冊以他們的產品。在hushed 口氣"它, 他說, 是因為我們沒掙任何金錢由寫指南。這不是會賺錢事業, 因此我們的管理不想要浪廢時間在這。" 一個懊惱表示出現了他的面孔, 他然後傾斜了更加接近並且前述, "我們失去了許多顧客因為我們沒有正派文獻。談論小事上精明, 因小失大!"
它不是僅遭受的顧客當指南是不充分或不存在的。怎麼樣雇員? 什麼發生當一位新工程師來在船上, 並且必須迅速學會嗎? 或什麼發生當現有的工程師需要使自己熟悉更他們的產品系列的不熟悉的方面? 用戶文獻, 如果適當地寫, 可能提供帶來速度一個柔和和高效率的方式。沒有它, 他們將被迫沉重依靠其它工程師教育他們, 如此浪廢大家的時期有關。幾星期, 如果不是幾個月, 可貴的人力可能被揮霍用這種方式。
2 。有適當的內部文獻
它不是僅公司未達到的用戶文獻。內部文獻頻繁地是傷亡, 因為公司擾亂發布產品。在他們的匆碌上帶來產品給市場, 公司經常讓他們的內部設計文件絕望地下落由路邊。
它不幫助, 程式員和工程師是臭名遠揚的為有無光澤表達能力, 並且文獻是他們很少享受的任務。我遇到了許多軟體公司, 例如, 軟體設計是難處理的混亂由於他們的缺乏建築文件, 接口描述和在代碼評論。哀傷地, 我看了相似的問題當它來到機械設計, 電子設計, 製造業規程? 您命名它。
我與公司或失敗了的工程師談了話, 或蹣跚地走在邊緣。幾乎不變地, 缺乏充分文獻是一個主要因素在這樣情況。
我總告訴我的上司並且工友, "我想要確信, 我的工作darned 很好提供了。如果我離開公司, 或如果我死在車禍, 為了我想要確信, 這個公司能前進沒有我。" 那應該是基本的原因的當中一個在保持之後周到文獻對確信, 公司由任何人的缺席不會致殘。
不幸地, 許多雇員採取相反策略。他們故意節約過度在文獻, 認為, 這將保證他們某一工作安全和有時, 這工作。但是, 一位聰明的雇主知道, 提供得很好的工程師更比保留他的卡片緊挨他的背心的其它工程師值得。後者也許是根本的近期, 但最後, 他是一個長期責任。
3 。忘記某人的觀眾
這個問題經常發生當開發用戶文獻。程式員和工程師頻繁地忘記, 他們的指南由是不熟悉的與他們的產品, 或沒有同樣技術技能的人讀。我記住一個公司在特殊機器控制器公司中在西海岸。他們的"用戶手冊" 是首字母縮略詞, 未定義期限和表面上任意想法可怕的大雜燴, 與大約十二規程被列出在沒有特殊次序。他們的用戶文獻缺乏如此基本的細節像怎麼開始控制器, 或怎麼停止它在情況下任一名初學者用戶應該盼望發現在指南的緊急狀態重要細節。
一個相關問題是疏忽使用適當的語言。考慮許多讀者不是當地英語報告人說, 當營銷一個產品在歐洲或亞洲, 或當寫彙編規程為外國出生的工廠勞工的案件。在這些情況下, 它也許是必要保持語言相當簡單。如果這不是可能說, 當談論要求很多精確度一可能經常補償由增加一些易於選上的圖、圖或相片的複雜細節。或者方法可能是有用的在使複雜文本更加容易吸收。
4 。是適當地圖表
這是不容置疑地clich6A©, 但真實的仍然圖片繪一千個詞。同樣, 指南對圖像的牌子明智的用途和用圖解法表示比一個將是容易瞭解由文本描述整個地組成。
一些認為這幼稚和多餘的。我不, 並且我的經驗表示, 多數用戶讚賞有這些視覺指南。記住; 無論複雜您的讀者是, 他們仍然是人。聰明, 否則仔細的讀者可能偶然地錯過某一重要細節, 特別是當急切要求時間。
5 。不力爭優秀
它是有趣看怎麼程式員和工程師能力爭優秀在許多他們的工作的方面, 採取確切在方法對面當它來到文獻。"誰對措辭關心無論如何?" 我聽見許多工程師說。"我們不寫□詩歌或電影劇本這裡。什麼事關是, 文獻必須是技術上準確的。"
這是一個駭人地眼光短淺的看法。技術準確性的確重要, 但因此是介紹和樣式。少量工程師會聽出現在浴巾和拖鞋裡的求職者, 或講話像谷女孩和以某種方法的訴訟律師, 這同樣工程師期待他們的傢伙techies (或更壞, 顧客!) 苦幹通過頁蜿蜒地流, 窮地措辭的文本。像拼寫, 語法和校對經常對待事關一樣根本比粗略掃視值得□什麼更的僅僅心煩piddle 細節。
(對我的安心, 我未遇到任何如此態度在我的就業場所。我急切說這, 唯恐任何人認為我抱怨我服務的人民! 不, 我發現我們全部讚賞優秀的價值, 我總是感激的。但我偏離主題。)
記住: 當寫為某人的傢伙techies, 你應該記住, 他們必須經常吸收長篇資訊量在缺乏時間。當寫為外行, 你儘可能應該使文本一樣柔和和容易消化, 唯恐他們變得失去在geekspeak 海洋。不管怎樣, 付出一點額外努力高雅和樣式問題可能做世界區別。
我不會進入關於什麼的細節構成好文字技術, 和會是在範圍這文本之外。滿足說, 一位好程式員或工程師應該確信, 他的文字可讀和組織完善, 並且它順利地流動從一個題目到另一個。
我會興奮在信仰之外如果我從未看見了其它二流打瓜的指南, 或如果我從未聽見了關於公司崩潰的其它故事由於不存在的文獻。一個絕望的幻想? 可能。但是, 我希望, 一些techies 那裡將讀這則消息, 並且他們將採取它對心臟。
關於作者
V. Berba Velasco 有博士學位在電機工程和使用他的貿易幾乎十年。在那時間期間, 他一再發現了好技術文字的重要性, 和可能發生從忽略它的價值的陷阱。
Velasco 博士當前工作作為一位高級電子和軟體工程師為多孔的技術被限制(http://www.immunospot.com, http://www.elispot-analyzers.de), 一個biotech 公司在克利夫蘭, 俄亥俄。在他的業餘時間期間, 他扶養渡渡鳥鳥, 建立人腦和戲劇以他的磁性monopoles 的彙集。
文章來源: Messaggiamo.Com
Related:
» Credit Secrets Bible» Cash Making Power Sites
» Home Cash Course
» Automated Cash Formula
網管得到HTML代碼
加上這條到你的網站！
網站管理員提交你的文章
無須登記！填寫好的表格和你的文章是在 Messaggiamo.Com 目錄！
