如何为Azure编写设计文档

在Cloudelicious的第一个帖子中,我写了关于规划的重要性,经历了所需决策并捕获文件中的决定和基石。本文的想法是分享我的经验中的见解,您如何为Microsoft Azure编写设计文档,解决内容数量(页数)和技术深度之间具有正确平衡的最重要的主题(详细信息级别)/希望文件的价值在最大值。

虽然每个人都同意该声明,但在使用新产品或在生产中的服务之前,它需要制定解决的计划,该计划是解决的“why”, “what” and “where”通常会在那些规划工作中推迟。不在以某种方式听起来熟悉的评论吗?

设计文档是浪费时间......

...没有人读设计doc!

但是,为什么找到一个很好的设计文件是如此困难?是因为人们不知道要写什么吗?令人惊讶的是,由于执行实施的顾问通常非常了解该技术。但是,我在EMEA周围的项目中经常看到一些常见的错误,这可以接受困难的文件:

  • ...建筑师倾向于过度工程师;
  • ...设计文档正在解释功能如何工作而不是描述设计决策;
  • ......人们在文件的细节中迷失了,并找不到他们正在寻找的东西;
  • ......由于项目的进展,大多数文件很少保持最新;
  • ......人们倾向于忘记写作期间需要回答哪些问题;
  • ......文档试图回答所有可能的受众的所有问题。

人们经常低估的是设计文件就像您,客户或经理和项目团队之间的书面合同。当您记录您的假设,决策,风险等时,您可以让别人有机会同意范围。当然,有时需求将会改变。特别是与新功能在非常高的频率上释放的公共云 - 几乎每天都是如此。随着技术细节会随着时间的推移而变化,将一般设计作为一个基础来说,它更为重要。

设计文件的概念

设计文件是一种与他人沟通的方式,设计决策是什么以及为什么所采取的决策是正确的决策。确定设计文件是否有用的最重要因素是如果它清楚地解释了作者的意图。建筑师应该想要分享他们的想法,工程师(和其他团队成员)应该想知道他们在建造什么。在某些时候,有人必须实施这种设计,因此我们希望使知识转移尽可能平滑。

看看下面的提示,并了解如何在为Microsoft Azure编写下一个设计文档时可以调整以下操作:

结构你的论文 - 以文档最重要的章节从内容表开始,并在另一个之后钻取一个级别。完成TOC完成后,添加子弹点以指示进入这些章节的内容。这样,你觉得这个结构是正确的 - 你有一个指示你的结构是否清晰,越过读者通过所有重要主题,是逻辑的,并缩小重复。

保持它 - 数量不会自动制作好文件。短文件更容易阅读和更舒适的才能维护,以保持内容最新。不要重复内容或复制& paste text from the Microsoft Azure文档 图书馆。反而, 添加脚注和refer to the online article for people who maybe don’t have the required background.

捕捉决定 - 设计文档是符合要求的决定。您应该始终能够列出至少一个与条件相关的令人信服的原因,了解为什么设计决定。必须保留和记录的原因。如果您不能提出设计决策的明显原因,那么它可能没有增加足够的价值。具有上下文将使在政治上处理项目的更容易。

一张图片胜过千言万语 - 图片或图表是可视化设计的绝佳工具,但它们无法传达设计决策背后的动机。添加支持文本并参考图片对于构建文档非常重要。别忘了使用 标题 有关更多可访问的参考。重要的是,利用图片来补充设计文件,而不是设计文件。

单独的内容详细信息 - 服务器名称列表或IP地址等详细信息使得设计文档不必要且难以读取。为什么不将这些信息移入附录或参考外部文件?确保使用保持交叉参考工作,不要让人们追捕他们想要的信息。

你用眼睛吃饭 - 当然,设计文件的主要目的是该技术。然而,花一点时间来改变你的字体,并确保风格的一致性可能对您的文件感觉的专业人士产生重大影响。不要低估这项任务的重要性。[/ vc_column_text] [vc_column_text]它是简单的,如果以有意义的方式满足要求,则通常被认为是良好的。如果文件可以运输此消息,您的工作已经完成了。

Microsoft Azure的设计文档

这似乎是太多的工作吗?通常,它不是。设计文档是符合类似模式,如果您有一个适用于您的结构,请将其保留并在下一个项目或更新期间增强它。 IP重复使用是键,每次重用现有材料时都会更好地完成工作。

看看下面的内容表(TOC);它突出显示最重要的主题,包括在设计文档中包含 Microsoft Azure:

  1. 介绍
    描述本文件的范围,谁是目标受众。捕获云的设计目标,约束,假设(如果有的话)和胃口(或视觉),并确保将快速摘要添加为概述。
  2. Azure. 建筑学 概述
    定义将使用哪个Azure区域的起点。此外,涵盖了订阅模型,管理角色,命名标准,基于角色的访问控制(RBAC)和Azure资源管理器等主题。
  3. Microsoft Azure网络
    网络代表文档中最重要的章节之一。网络结构,Expressroute,虚拟网络地址空间,虚拟网络网关等的东西, DNS. ,网络安全组,强制隧道,......将来到这里。将IP列表移动到外部文档或附录。
  4. Microsoft Azure存储
    捕获关于工作负载要求(例如,路径,IOP),存储帐户,托管磁盘和虚拟硬盘的决策。加密和Azure文件也会成为一个重要的部分。
  5. Microsoft Azure Compute.
    我们通常关注在此处的基础设施 - AS-Service(IAAS),其中包括有关VM类型,实例,可用性集的信息,如何记录图像,以及可以使用哪些VM扩展。
  6. 微软天蓝色的身份
    定义现有的内部部署标识和名称服务将如何在Azure中提供,以及如何使用Azure Active Directory(AAD)扩展到。这不一定必须涵盖广告或AAD设计。
  7. 遵守& Security
    设计指南,以确保安全采用Azure,包括PCI-DSS(如果需要)的认证和与Azure Security Center集成。
  8. 备份
    备份的设计指南,OW现有解决方案将用于云或将如何使用Azure备份。使用Azure Site Recovery(ASR)触摸灾难恢复要求,云到云的理想章节。
  9. 管理和维护
    关于如何将新部署的服务如何集成到现有监控和补丁管理中的决策。位置日志分析,Azure自动化和其他管理功能以支持这些活动。
  10. 附录
    将全命名约定移动到附录中。该文件的末尾也是保持所有链接到在线资源的绝佳场所。

你可以找到 进一步了解命名约定 对于我们的下一个博客文章中的Azure资源。当您启动自己的Azure设计时,本文可能会有所帮助。

那里’还有一件事…

在本文中,我分享了我的想法和做法如何为微软Azure编写设计文件,并表明该等创建的重要性是多么重要。当然,“不只是一种方式”,每个客户都有他们的要求或偏好。人们对每个项目的成功至关重要,特别是当您为服务器和应用程序定义云平台时。您最有可能将您的团队带到设计研讨会上。看看描述的文章 建筑师的不同口味;这可能会对您的人员配置产生积极影响。

标签

相关文章

3 thoughts on “如何为Azure编写设计文档”

发表评论

本网站使用AkisMet减少垃圾邮件。 了解如何处理评论数据.