道路は、建築家をリードする - アーキテクチャと設計文書のライティングスキルについて話します

はじめに:

これは、多くのロジックコードがない、サイドストーリーである完全に「ソフト」スキルですが、建築家を組み合わせた構造を持っているとなってどのようにそれは非常に重要です。

あなたがから来たプログラムいないのであれば、それは単にないし、建築家になることはできませんがこの点を明確にするために、建築家自身「プログラマ」は、男だけの全く言葉ではありません。

プログラマがそれを持っていないとして、建築家は、何ですか?

これはと呼ばれる能力がある「文書のライティングスキルを。」

、ソフトスキルとハードスキル

経験豊富なプログラマであることに、建築家の添加として、それはまた、1と呼ばれるドキュメント・スキルなど、適切なソフトスキルを持っている必要があります。

1.初見のハードスキル

(例えば保険、銀行、CRM、DWなど...)それぞれの領域での製品と経験を使用して柔軟なフレームワークやコード我々はハードスキル、それを呼び出すには、これらのスキルを持っていないあなたは、資格のプログラマーになることができません。

プログラマとITが異なっている、プログラマは、IT業界の主要な軍隊ですが、あなたはそれが正しい、あなたがITスタッフであることを、秘書であったとしても、分析のための部門のウェブサイトやソフトウェアのニーズですか?したがって、これらの事は、「ハード」条件の建築家であることをしています。

2.ソフトスキルとは何ですか

ソフトスキルは、ドキュメントのスキル、プレゼンテーションスキル、コミュニケーションスキル、(BS小さな日本、日本人は含まない)、対応する言語スキル、マネジメントスキル、リーダーシップ、これらを参照します。

もちろん、ずっと、ずっと。

2.1ドキュメンテーションスキル与プレゼンテーションスキル

今日は主にドキュメントのスキルやプレゼンテーションスキルについてです。

これら2つの点を過小評価したくない、それは彼自身にコンパイルプログラミングが、それは彼がどのようにどのように深く、アルゴリズムを書いたと言われていた、行くと言われました。最初のチームは今、あなたは現在の世界経済環境にあるものな顧客志向の背景があなたのアイデアを受け入れるあなたのアイデアを理解する他、に明確に表現することはできません知っている人あなたの会社の製品を選ぶのか?

ここでは2つの例を示します。

Buchinは、彼が偉大な数学者である、それはおそらく多くの人が非常に深いです文献にBuchinの素養を知らない、ではありません。

Buchinはかつて言った:私の論文は、私が表現するために教科書の言語を使用し、そうでない場合は、言語、私は私のアルゴリズムを表現するために、より正確でより多くを理解できなかったの言語を学ぶ必要があるので、なぜ私は、言語、言語が好きです。

コンピュータのC言語のチュートリアル良い強いタンのよく知られた学者がかつて言った:ブロックダイアグラムを表現するために、シンプルで簡単な言語で複雑な問題を配置する能力は、最高の論文です。

例の実際のポイントに加えて、あなたは入札コンテストであり、あなたのデザインが良いかもしれませんが、顧客がそれを理解し、設計を受け入れることを可能にする方法?

そして、あなたは私たちの平時や実務家で意識を高める必要があり、マニュアル・スキル、ドキュメンテーションスキルとプレゼンテーションスキルについては、リンクされていると言います。

2.2「梱包」が得意になる方法を知っているために、

多くの人々が押し寄せるの顔であることとあなたの同僚や友人に話すかもしれないスキルですが、あなたの上司の顔や顧客の前で、となっている「宣伝、デモンストレーション、講義は、販売」そのプレゼンテーションスキル「商品を縮小」でした。なぜ?

実際には、あなたのスピーチ論文は、我々は、一般的にWORD PPTまたは不十分な準備、鈍い、すべての味、そしてあなた自身の設計を行う際にも許されないことを使用する多くの時間を描画します。

ハードスキルは、あなたが良いドキュメント(PPTクラス)と結合された勇気の50%を持っているハード十分なハードスキルを持っている、したがって、あなたの自信であなたの勇気は、別の50%、そして、あなたのプレゼンテーションスキルとなっていますそれが促進されました。

だから、何回プレゼンテーションスキルは、ハードスキル+のドキュメントのスキルに等しいです。

「幸い、デロイトの一覧」私は多くの人がそれを見ていると信じという映画がありますか?アイザックスタイン、彼のサージングとあなたがお金を稼ぐことができるか、会社を設立するために彼らの計画について話を - 未満万元に対して、30分に始まり幸いユダヤ人の、「資本金」、チャンドラーは、ユダヤ人の会計士を見つけるために、集会に来ました。そして、イサクスタインは彼のことを尋ねました:

何が出て、その後、私は「ゴールデンマスター」お金を見つけ、私は人間だ、私は一つのことを理解させてください。

幸い、Delekのは押し出しの後一緒に、彼の手をたばこを吸う「のプレゼンテーションを、これは私が一番何をすべきか、されて」ここでのプレゼンテーションは、パッケージとして考えることができます。

性能、機能、寿命が同じである場合にもカップの中国生産と米国は、私は、米国が高価な商品を販売し、なぜされると考えていますか?それは、「ハリウッドスタイル」のマーケティング戦術である「パッケージ」に基づいて、再びハードスキルで行われているので。

「パッケージ」ではなくChedanと自慢することを学ぶことが全く無価値を通して見た後に、「不正行為」が含まれていない場合は、建築家は、さらに美しい何かを思い付くので、。しかし、我々は良い品質の優れた技術をもとに、それを「パッケージ」を行ってもいいです、私はあなたが一歩近づく成功になると確信しています。

第三に、どのように文書を書いて、あなたのドキュメントのスキルを向上させるために

私の前の会社では私が明らか書くことができるように設計要件に従って文書化要件を書くため、チームリーダーの一回ので、いくつかの他の上級の空気のバーストを持っていませんでした。

5記事にもたらし、基本的なものは使用しないでください。

まず、さえ1,2,3,4-リストされていなかった、私たちは各点の機能について話しますが、意味のない説明の長い期間のため、直接COPY通路がダウンしている公式サイトからさ、に運ば少なくとも、あなたはアドバンテージ・ポイントまたはそのコントラストメリットとデメリットポイントバーを持っています。

1,2,3,4と、第二にもたらし、これは単に素晴らしいです、すべての1,2,3,4としてマークアップされました。

「箇条書き」事務エディタを駆使するには、「4-芒星」は「階層化」機能のポイントを説明するために、段落の前に「少し」の利点を代表して「√」、明るいスポットを表し、スピーカーが読んでより明確に。

このようにそれを入れて、あなたはまだリーダーとして自分自身を置きますか?右?

3.1百聞は一見にしかずです

私たちは、監査ログ機能モジュールを記述するとき、私たちは以下の画像を添付することができますので、もし、春をどうすると言うことは、それより鮮やかになるではないでしょうか?

通向架构师的道路——漫谈架构与设计文档的写作技巧


一个架构文档,从基本的来讲需要有:

  • Logic View(逻辑视图)

  • Physical View(物理视图)

  • Network Structure(网络拓卜图)

  • Workflow/Process Flow(流程图)

你在描述你的流程时你怎么表达你的if else if else,对吧?有个流程图是不是会更好让人懂你所描述的这个流程是一个什么样子的呢?

那我画个流程图去。。。画啊画,画完后拿过来一看:

黑线框、框内有几个字,几个带箭头的线连一下。。。不错。。。是画对了,可是你有没有想过,有些业务场景中流程图往往还要表达不同的”业务边界“啊。。。

拿下面的一个图来说,是不是这样的表达比只有黑框框+带箭头的线+几个文字更加易懂啊?

通向架构师的道路——漫谈架构与设计文档的写作技巧


3.2 画好你的图

3.2.1 架构图的配色与表达手法

不要认为画图是”美工“的事,你是设计人员,你是架构师,画好一个应用图是你的本职工作,图中需要什么图标可以把你的需求告诉美工,美工再会去处理。

一般来说,我们为了表达一个系统的模块组成,我们通常会用:component view来表达如下面这样的图

这个被称为”自上而下“的一个平面图,用于表示”服务边界

通向架构师的道路——漫谈架构与设计文档的写作技巧


如果你考究的话还可以提供一个”剖视图“,如典型的用于表示详细业务组件的”侧面剖视图“:

通向架构师的道路——漫谈架构与设计文档的写作技巧


这种Component View一般都是跟着你的总架构图和网络拓卜图的后面出现的,这三套图我称它为“炮鸣三声”(起兵啦。。。)。

因此这样的图往往会使用“暖色调”,以几何或者立体的色块来展现,带给观看者强烈的视觉冲击,架构师的功底基本可以集中体现在这三套图中,这三套图同时也起到了“先声夺人”吸引观众的眼球,注意力的作用(那边的女孩看过来看过来,我的钞票多。。。嘿嘿嘿)

如下面这样的一个总架构图的表现手法:

通向架构师的道路——漫谈架构与设计文档的写作技巧


对吧,暖色调,以几何或者立体的色块来展现

3.2.2 以图绘意

我这边提个问题:如何表达一个”业务规则“,如何去表达一个”工作流“,就是”业务规则“这四个字我用图怎么表达。。。工作流这三个字我用图怎么表达?大家想一下。

来,看看下面的图:

这个图一看就知道是在表达process或者说是工作流

通向架构师的道路——漫谈架构与设计文档的写作技巧


这个图代表”规则“,规则就是一组if else if if

通向架构师的道路——漫谈架构与设计文档的写作技巧


对吧。。。现在来个更难的,我的业务规则用的是规则引擎,且内核是jboss rulz,嘿嘿,怎么用图标达,来。。。下面给出我的答案:

通向架构师的道路——漫谈架构与设计文档的写作技巧


对吧。。。看到了吗。。。图用来绘意,但图不能乱用,就拿这个”系统中使用了JBOSS  RULZ来作为规则引擎"这个描述来说,你要画的图其实是建立在你的Hard Skill上的。

3.2.3 依照“八股文”来绘制设计图

八股文就是有条理有章矩,不管什么样的文章你按照八股文去写,写出来都是一样的层次,我们考四级英语的“写作”这一本时其实也是有“章法”可循的对吧?

那么这个设计图的画法也是有章可循的,也是有它的“八股文”样板的。

前面说了,上手三套图先声夺人,抢人二目,那么在架构设计文档中还会充质着种种模块,子模块,功能设计,功能点描述图。。。如果你也来个一概而论,那就不是先声夺人了,而是“喧宾夺主“了,呵呵呵。

这种子模块、功能设计或者是功能点描述往往往以点、线为主,以点、线来连成一个面,而面中”娄空“,如下面的样例:

通向架构师的道路——漫谈架构与设计文档的写作技巧


四、如何画出准确且“漂亮”的设计图呢

七叔:You are beautiful...啊...you are beautiful...You are so handsome...啊You are so handsome...

周星星:七叔,你不要这样好吧。。。七叔。。。来人啊。。。

我在前一天即第二十五天中用来描述DbUnit的优点时用到了一套图,它们是这样的,大家还记得吧?

通向架构师的道路——漫谈架构与设计文档的写作技巧


右边的文字,没什么稀罕的,都是配色而己,关键在于左边的这个图。。。hoho,很多人问我用的是什么工具画的?

我告诉你们,我不是美工,我其实是在“拼图”,如这幅图的制作:

通向架构师的道路——漫谈架构与设计文档的写作技巧


我是用了以下这5幅小图标,拼制而成的:

通向架构师的道路——漫谈架构与设计文档的写作技巧


不是这么简单的,随便画画就成了,都要花功夫的、花心思去制作的。

  • 平时自己看到好的可以表达某个意义的图片,存下来,分门别类

  • 看到人家写的好的架构文档,存下来,看看人家是怎么去描述一个功能点的

  • 多搜集一些IT上专用的图标,小图片,logo

IBM的文档是我看到过最恐怖的文档,基本上这里面的架构文档出来都一个腔调,没什么文字,都是图,连个“登录过程”都用图表达连个“源码check in check out”的管理流程都用图表达

保持你的图系一致及风格的一致,你可以用卡通系、商务系任何一个系的图来表达你的设计思想,但是当你的第一幅图用的就是哪个系时,你的文档中所有的图都请用这个系列,而不建议你混杂使用你的图系。

五、图文混杂的技巧

什么都不多说,上截图,大家自己去感受一下吧

通向架构师的道路——漫谈架构与设计文档的写作技巧


今天就说这么多,希望对大家提高你的设计文档写作水平有所提高吧。


おすすめ

転載: blog.51cto.com/14455981/2433756