Preface:
This is a side story, there is not much logic code, is entirely a "soft" skills, but it is very important how you become architects have a combined structure.
To clarify this point, the architect itself "programmer", are not just utter words of the guys, if you're not a program that you came from, though it simply does not and can not become an architect.
What is then the architect as a programmer does not have it?
Which has an ability called "document writing skills."
A, Soft Skill and Hard Skill
As an architect addition to being an experienced programmer, it also must have the appropriate Soft Skill, including one called Documentation Skill.
1. The first look Hard Skill
Flexible framework and code using the product and experience in the respective domain (such as Insurance, Banking, CRM, DW ...) We call it Hard Skill, do not have these skills you can not become a qualified programmer .
Programmers and IT are different, the programmer is the IT industry's main army, but if you are a website or software needs of the Division for analysis, even if it is a secretary, that you are an IT staff, right? So these things are to be architect of a "hard" conditions.
2. What is the Soft Skill
Soft Skill refers Documentation Skill, Presentation Skill, Communication Skill, corresponding Language Skill (not including Japanese, BS small Japan), Management Skill, Leader Ship, these.
Of course, much, much more. . .
2.1 Documentation Skill与Presentation Skill
Today is mainly about Documentation Skill and Presentation Skill.
Do not want to underestimate these two points, it was said that he himself compiled programming goes, it was said that he wrote the algorithm how how deep, then. . . The first team now and you know what is in the current world economic environment such customer-oriented background can not express clearly to others, who will understand your ideas, who will accept your ideas, who choose your company's products?
Here are two examples:
Buchin, he is a great mathematician, is not it, perhaps a lot of people do not know Buchin attainments in literature is very deep.
Buchin once said: Why do I like the language, the language, because my thesis, I need to use textbook language to express, if not the language, learn the language I could not understand more accurate and more to express my algorithm.
Well-known scholar of computer C language tutorial good strong Tan once said: the ability to put complex issues in simple and straightforward language to express the block diagram, is the best papers.
Besides the actual point of the example, you are in a bidding contest, your design might be good, but how to allow customers to understand and accept your design it?
Then you need to increase awareness in our peacetime or practitioners say about your documentation skill, documentation skill and presentation skill are linked.
2.2 To know how to be good at "packaging"
Presentation Skill That "propaganda, demonstrations, lectures, selling" is a skill that many people might be in the face of surging and talk to your colleagues or friends, but in the face of your boss or in front of customers, has become "shrink goods" was. . . why?
In fact, many times that your speech papers we generally use WORD PPT or inadequate preparation, dull, every taste, and that when you do your own design also not allowed to draw.
Hard Skill is therefore your confidence, have a hard enough Hard Skill you have 50 percent of courage coupled with a good Document (PPT a class) Your courage has also been another 50%, then your Presentation Skill it promoted.
So many times you Presentation Skill is equal to Hard Skill + Documentation Skill of.
There is a film called "Fortunately, Deloitte's List" I believe many people have seen it? Beginning 30 minutes, against less than 10,000 yuan, "capital" of the Jewish Fortunately, Chandler came to the gathering, to find a Jewish accountant - Isaac Stein, his surging and talk about their plans to set up a company, how you can make money. Then Isaac Stein asked him that:
Please let me understand one thing, I'm a person, then I find the "golden master" money, what you out. . . ?
Fortunately, Delek smoking a cigarette, his hands together after pushing out a "presentation, this is what I do best," here's presentation can also be considered as a package.
Also a Chinese production of cups and the United States, if the performance, functionality, service life are the same, I believe the United States is selling expensive goods, and why? Because it is carried out with the Hard Skill again on the basis of a "package", which is "Hollywood-style" marketing tactics.
To learn to "package" but not Chedan and bragging , because the architect to come up with something even more beautiful, if that is contains no "cheating", after being seen through worthless. But we are good to go "packaging" it on the basis of good quality good technology, I believe you will be one step closer to success.
Third, how to write a document and improve your documentation skill
In my previous company did not have a burst of air, once so several other senior of the Team Leader to help me write documentation requirements in accordance with the design requirements to be able to write clear.
Brought to five the article, do not use the basic one.
First brought to, we are talking about a function of each point, but for a lengthy period of meaningless explanation, either directly from the official website is down COPY passage, did not even listed 1,2,3,4, At least you have a Advantage Points or that contrast Benefit and Disadvantage Points bar.
Brought to the second, with 1,2,3,4, but this is just great, all marked up as 1,2,3,4.
To make good use of "bullet list" office editor, "4-pointed star" represents the bright spot, "√" on behalf of the advantages of "little bit" before a paragraph to explain the function point "layered", the speaker read clearer.
Put it this way, you put yourself as a reader yet? Right?
3.1 a picture is worth a thousand words
When we describe an audit log function module we say to do with Spring, so if we can attach a picture below is not it will be more vivid it?
一个架构文档，从基本的来讲需要有：
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”的管理流程都用图表达。
保持你的图系一致及风格的一致，你可以用卡通系、商务系任何一个系的图来表达你的设计思想，但是当你的第一幅图用的就是哪个系时，你的文档中所有的图都请用这个系列，而不建议你混杂使用你的图系。
五、图文混杂的技巧
什么都不多说，上截图，大家自己去感受一下吧
今天就说这么多，希望对大家提高你的设计文档写作水平有所提高吧。