`
strongant
  • 浏览: 65112 次
  • 性别: Icon_minigender_1
  • 来自: IT
社区版块
存档分类
最新评论

关于架构设计文档一些想法

阅读更多

 

架构设计文档应该体现如下四要素:

  • Logic View(逻辑视图)
  • Physical View(物理视图)
  • Network Structure(网络拓卜图)
  • Workflow/Process Flow(流程图)

每一种图都有自己的画法,并且有比较经典的图,这些图的组合:框框+线条+文字说明

 

下面用职能图来描述流程图,之前画流程图都是用很简单的黑框框+线条,这样给客户看的话不是很生动,也不能一目了然

 

 

总体架构图,也叫接口调用图

 

架构设计文档还包含着:各种模块,子模块,功能设计,功能点描述。。。。

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

 

 

 

做好架构文档的一些建设:

  • 平时自己看到好的可以表达某个意义的图片,存下来,分门别类
  • 看到人家写的好的架构文档,存下来,看看人家是怎么去描述一个功能点的 (我觉得这点很重要,也是快速提高写文档能力)
  • 多搜集一些IT上专用的图标,小图片,logo

 

 

 

分享到:
评论

相关推荐

    产品设计及技术架构

    产品设计与技术架构探讨的基本信息,还可以,有想法的可以下载

    Android代码-Android MVP模型架构设计

    这是我项目架构的初型, 不是很完善,完善的架构大家根据自己的想法和app去扩展的(文档打不开的发邮件我,我给原档) MVP说明 如果不是很了解mvp的可以先去看看mvp相关的文章。 一个v对应一个p,多个v对应多个p,...

    数据库架构设计.pdf

    数据库架构设计 author:skate time:2013/06/04 数据库架构设计 最近在考虑如何能设计好⼀个数据库架构,下⾯是个⼈⼀点想法,欢迎⾼⼈指正 任何系统都不是独⽴的,是⼀个⽣态系统,数据库也是⼀样的,要使其在其⽣...

    「大数据干货」基于Hadoop的大数据平台实施——整体架构设计.pdf

    1. 软件架构设计 ⼤数据平台架构设计沿袭了分层设计的思想,将平台所需提供的服务按照功能划分成不同的模块层次,每⼀模块层次只与上层或下层的模块 层次进⾏交互(通过层次边界的接⼝),避免跨层的交互,这种设计的...

    architecture-document-template:产品架构文档模板

    例如,基础架构设计师或DevOps工程师很少需要了解软件体系结构的详细信息(所用框架的详细信息或如何处理错误)。 同样,PO或业务架构师将对应用程序模块及其主要交互(“批处理B称为服务S”)的宏观视图感兴趣,但...

    docs-tutorial::writing_hand: 开发者如何编写优雅的技术文档

    当你需要展示你的想法、技术分享、架构设计,这时候好的技术文档变的至关重要。 文档伴随开发者的日常工作,例如:开源软件官方文档、第三方平台文档、系统设计文档等等,好的技术文档让人赏心悦目、赞不绝口,但...

    微服务架构和基于容器参考应用程序eShopOnContainers.zip

    然而,我们鼓励下载和审查“架构与开发电子书”,因为在指导中解释的架构风格和架构模式和技术在解释许多模式实现时使用此参考应用程序,因此您将更好地了解上下文,设计以及在当前架构和内部设计中采取的决策。...

    Java毕业设计-基于springboot开发的在线外卖系统-附毕设源代码+说明文档.rar

    此外,该项目还附带了详细的说明文档,对项目的整体架构、功能模块、数据库设计等进行了全面的介绍。这不仅有助于学生快速上手项目,更能够引导他们深入理解项目背后的设计思想和实现原理。 最重要的是,该项目具有...

    Camunda流程自动化.pdf

    为什么要建模 - 模型是易于测试的,在初期有一个可测的模型可以帮助减少试错成本,注意这里说的测试并不是指程序方面的测试. ...如果希望用它来展示组织架构,数据流,业务规则,策略,那这种想法是错误的.

    IntalioTempo研究

    文档编写目的该文档通过对Tempo这个开源工作流引擎的架构设计进行描述,学习其设计方法,重要的是了解其对于BPEL4People规范的实现机制,以其在后续的项目开发中可以集成到BPEL引擎中。本文档主要分为以下几个部分,...

    《Axure快速原型设计》(陈良泳)

    是一个快速的原型工具,主要是针对负责定义需求、定义规格、设计功能、设计界面的专家,包括用户体验设计师(UX)、交互设计师(UI)、业务分析师(BA)、信息架构师(IA)、可用性专家(UE)和产品经理(PM)。...

    Java毕业设计-基于springboot开发的大学生就业服务平台-附毕设源代码+说明文档.rar

    通过阅读文档和参考源代码,开发者可以快速了解平台的架构和实现原理,并在此基础上进行定制开发,实现自己的创新想法。 总之,“基于Spring Boot开发的大学生就业服务平台”是一个功能强大、易于扩展的综合性就业...

    asp.net知识库

    关于能自定义格式的、支持多语言的、支持多数据库的代码生成器的想法 发布Oracle存储过程包c#代码生成工具(CodeRobot) New Folder XCodeFactory3.0完全攻略--序 XCodeFactory3.0完全攻略--基本思想 XCodeFactory...

    Axure快速原型设计

    是一个快速的原型工具,主要是针对负责定义需求、定义规格、设计功能、设计界面的专家,包括用户体验设计师(UX)、交互设计师(UI)、业务分析师(BA)、信息架构师(IA)、可用性专家(UE)和产品经理(PM)。...

    adr:体系结构决策记录(ADR)

    ADR代表体系结构决策记录,它是一种设计文档,为软件开发提供了高级,简洁的文档。 目的是使这些文档成为Straw Hat团队与软件相关文档的真实来源,以及团队讨论软件开发指南并达成共识的方式。 入门 ADR的新手? ...

    droidlet:模块化的嵌入式主体架构和用于构建嵌入式主体的平台

    机器人该存储库,相应的教程和文档仍在完善中(尚未准备好)。 droidlet可帮助您快速构建执行人员指定的多种任务的代理(真实或虚拟)。 代理可以在循环中使用自然语言,记忆和人类。 droidlet是AI研究人员的早期...

    基于Java的京东电商系统的设计与实现.docx

    第1章 系统概述 1 1.1 系统开发背景 1 1.2 系统特点 1 第2章 项目开发相关技术基础 2 2.1 Java语言 2 2.2 MVC模式 2 2.3 SOA架构设计 3 2.4 Spring概述 3 2.5 Mybatis概述 3 2.6 SpringMvc概述 3 2.7 JavaWeb开发...

    json-graal:该项目旨在为JSON创建javascript绑定,该绑定将允许在生成HTML表单和符合JSON文档的架构之间往返

    并可能通过一系列推断/生成进行JSON TO FORM Javascript绑定_注意:不再使用beta数据链接,因为它被设计破坏了注意:不再使用beta和完全损坏的jquery模板。 长寿命车把有关此功能的想法,请在您喜欢的浏览器中打开...

    javalruleetcode-docs:文档

    讨论区分享自己的一些想法和实践经验。 Netlify: Gitee Pages: GitHub Pages: 高并发架构 缓存 分库分表 读写分离 高并发系统 分布式系统 系统拆分 分布式服务框架 分布式锁 分布式事务 分布式会话 高可用架构 高...

    javalruleetcode-doocs:文档

    分享自己的一些想法和实践经验。也不妨 Star 关注 ,随时追踪项目最新动态。 本项目基于 进行构建,并同步部署(这里用到 自动部署工具,非常好用的一个开源工具,欢迎 Star 关注)在以下三个站点: Netlify: Gitee ...

Global site tag (gtag.js) - Google Analytics