도로는 건축가를 선도 - 건축과 디자인 문서의 쓰기 능력에 대해 이야기

서문 :

이것은 많은 로직 코드가없는, 측면 이야기 완전히 "소프트"기술이지만 건축가가 결합 된 구조가 어떻게 매우 중요합니다.

당신이 온 프로그램하지 않으면 단순히하지 않습니다와 건축가가 될 수 없지만이 점을 명확히하기 위해, 건축가 자체 "프로그래머는", 사람의 단지 완전한 단어 수 없습니다.

프로그래머가 그것을 가지고하지 않는 건축가는 무엇입니까?

어느라는 기능이있다 "문서 작성 능력을."

A, 소프트 기술과 하드 스킬

숙련 된 프로그래머가되기 위해서는 건축가 또한, 그것은 하나 개라는 문서 스킬을 포함한 적절한 소프트 스킬을 가지고 있어야합니다.

1. 첫번째보기 하드 스킬

각 도메인의 제품과 경험을 (예 : 보험, 은행, CRM, DW ... 등) 우리는 이러한 기술이없는, 하드 스킬를 호출하여 유연한 프레임 워크 및 코드 당신은 자격을 갖춘 프로그래머가 될 수 없다 .

프로그래머와 IT가 다른 프로그래머는 IT 산업의 주요 군대는하지만, 당신이 바로, 당신은 IT 직원임을, 비서 경우에도, 분석을위한 부문의 웹 사이트 또는 소프트웨어 요구 사항이 있다면? 그래서 이런 일이 "하드"조건의 건축가한다.

2. 소프트 스킬은 무엇입니까

소프트 스킬 문서 스킬, 프레젠테이션 스킬, 커뮤니케이션 스킬, 관리 스킬, 리더 선박, 다음 (일본어, BS 작은 일본 제외) 해당 언어 기술을 의미합니다.

물론, 훨씬, 훨씬 더. . .

2.1 문서 스킬 与 프리젠 테이션 스킬

오늘은 문서 스킬 및 프리젠 테이션 스킬에 대해 주로.

이 두 점을 과소 평가하지 마십시오, 그것은 그가 자신의 컴파일 된 프로그램은 그가 얼마나 얼마나 깊은, 다음 알고리즘을 쓴 말했다 간다라고했다. . . 첫 번째 팀은 지금 당신은 현재의 세계 경제 환경 속에있는 것을 같은 고객 중심의 배경이 당신의 아이디어를 받아 들일 것입니다 당신의 아이디어를 이해 사람,,,에 명확하게 표현할 수없는 알고있는 사람 회사의 제품을 선택?

여기에 두 가지 예는 다음과 같습니다

Buchin, 그는 위대한 수학자는 문학은 매우 깊이에 아마 많은 사람들이 Buchin의 소양을 모르는, 아니입니다.

Buchin 한 번 말했다 : 이렇게하는 이유는, 언어, 언어를 좋아하는 내 논문 때문에, 나는 내 알고리즘을 표현하는 것이 더 정확하고 더 이해할 수있는 언어를 배우고, 그렇지 않은 경우 언어, 표현하는 교과서 언어를 사용해야합니다.

컴퓨터 C 언어 튜토리얼 좋은 강력한 탄의 잘 알려진 학자는 한 번 말했다 : 블록 다이어그램을 표현하는 단순하고 간단 언어로 복잡한 문제를 넣을 수있는 능력이 가장 좋은 논문입니다.

예제의 실제 점 외에, 당신은 입찰 대회에, 당신의 디자인은 좋은 수 있습니다 만, 어떻게 고객을 이해하고 디자인을 받아 들일 수 있도록?

그럼 당신은 우리의 평화에 대한 인식을 높이기 위해 필요하거나 실무자는 문서 기술, 문서의 기술과 프리젠 테이션 기술이 연결되어에 대해 말한다.

(2) "포장"에서 좋은 방법을 알고

"선전, 시위, 강의, 판매하는 것은"많은 사람들이 급증에 직면하고 동료 또는 친구에게 이야기하지만, 당신의 상사 또는 고객의 앞에 얼굴에,이되었다 수있는 기술이라고 프리젠 테이션 스킬 "상품을 축소"이었다. . . 이유는 무엇입니까?

사실, 당신의 연설 논문은 우리가 일반적으로 WORD PPT 또는 부적절한 준비, 무딘, 모든 취향, 당신은 당신의 자신의 디자인을 할 경우에도 허용되지 않는 것을를 사용하여 여러 번 그립니다.

하드 스킬은 당신의 용기는 또 다른 50 %, 다음 프리젠 테이션 스킬이었다 당신이 (PPT 클래스) 좋은 문서와 결합 용기의 50 %를 가지고 열심히 하드 스킬을 가지고 있으므로 자신감이다 그것은 승진.

그래서 몇 번이나 프리젠 테이션 스킬 하드 스킬 +의 문서 스킬과 같다.

"다행히, 딜로이트의 목록"나는 많은 사람들이 그것을 보았다 생각이라는 영화가있다? 이삭 스타, 그의 급증하고 돈을 벌 수있는 방법을 회사를 설정하는 그들의 계획에 대해 이야기 - 이하 1만위안에 대해 30 분부터, 유대인의 "자본"다행히, 챈들러는 유대인 회계사를 찾기 위해 모임에왔다. 이삭 스타 인 그를달라고 요청 :

내가 한 가지를 이해 주시기 바랍니다, 나는 그 때 나는 무엇을 "골든 마스터"돈을 찾을 수있는 사람입니다. . . ?

다행히, Delek가 밀어 후 함께 그의 손을 담배 "프리젠 테이션을, 이것은 내가 가장 잘하는 것입니다"여기의 프리젠 테이션은 패키지로 간주 될 수 있습니다.

성능, 기능, 수명이 동일한 경우에도 컵의 중국 생산 및 미국, 나는 미국이 고가의 상품을 판매하고, 왜 생각? 그것은 "헐리우드 스타일"마케팅 전술이다 "패키지"를 기준으로 다시 하드 스킬로 수행되기 때문에.

"패키지"하지만 Chedan과 자랑에 내용 이 더 쓸모 통해 본 후, "부정 행위"가없는 경우 건축가는 더욱 아름다운 것을 가지고 올 있기 때문에. 그러나 우리는 좋은 품질 좋은 기술에 기초를 "포장"갈 수있다, 나는 당신이 한 걸음 더 가까이 성공이 될 것으로 판단된다.

셋째, 어떻게 문서를 작성하여 문서 기술을 향상시키기 위해

내 이전 회사에서 내가 분명히 쓸 수 있도록 설계 요구 사항에 따라 문서의 요구 사항을 작성하는 데 도움 공기의 버스트, 팀 리더의 한때 여러 가지 다른 수석이 없었다.

오 기사에 가져, 기본 하나를 사용하지 마십시오.

첫째, 심지어 1,2,3,4 나열되지 않은, 우리는 각 지점의 기능에 대해 이야기하지만, 의미 설명의 긴 기간 동안, 직접 복사 통로가 다운 공식 웹 사이트에서하는로 가져 적어도 당신은 이점 포인트 또는 대비 장점과 단점 포인트를 줄 수 있습니다.

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