`
Godlikeme
  • 浏览: 165164 次
  • 性别: Icon_minigender_1
  • 来自: 北京
社区版块
存档分类
最新评论

书写开发文档和平时随手写些非规范文档

UML 
阅读更多
现在平时写的一些非规范文档有些乱、时间长了自己都有些看不懂。
主要的开发文档就是Functional spec 和 Technical Spec。
Functional Spec 映射需求到功能性,
Technical Spec 映射功能到实现。

以后随手写一些文档的时候也依照这些要求,相对规范,比较容易将来整理形成正式文档。
内容大于形式,注重实效。一份内容,一份模版,需要的时候找一个熟悉这部分内容的人,很快攒出一份文档出来。

关键在内容的组织上,而不是模版形式本身。
如果把需求,功能,实现在不同层面上讲清楚,层次清晰,详略得当。需要业务知识、技术知识、项目经验、分析能力、表达能力。

这些都是要在开发用的上的文档,内容一定要详实,体现问题的前提假设、实际问题、解决问题的思路,以及可能会出现的问题。FS,TS只不过要体现问题的不同层面,层次把握也很重要。
文档里面可以适当的给出一些图示,图示给人以更好的直观印象,表达能力强于文字描述;但图一定要规范,要有文字解释,避免的误解。没有解释的图很容易误解,既是是规范的UML也是一样的。表达能力强的方式对理解者的要求比较高,抽象的层次相对高了,还是那句老话,问题本身的复杂度不会因表达的方式而简化,而且更高的抽象层次往往需要理解者有更多的专业知识才能正确理解,否则误解难以避免。

空洞的套话、忽悠的话对开发没意义,没必要的都不要。
分享到:
评论

相关推荐

    软件开发文档书写规范

    《软件开发文档书写规范》是针对项目全周期的详尽指南,它涵盖了从项目启动到交付的每一个关键阶段,旨在确保开发过程的规范化和高效性。这份文档特别强调了在Linux环境下的应用,这意味着它可能涉及到与Linux系统...

    WEB前端开发规范文档

    WEB前端开发规范文档旨在通过制定一系列标准化的操作流程和规范,提升开发效率与质量,确保项目的可持续性和可维护性。该文档详细介绍了WEB前端开发的基本准则、文件命名规则、HTML、CSS以及JavaScript的编写规范等...

    前端开发规范文档_pdf文件

    这份"前端开发规范文档_pdf文件"涵盖了多个重要的知识点,旨在帮助开发者建立良好的编码习惯,提高代码的可读性和规范性。 首先,开发规范中会详细讲解命名规范。命名规则是代码可读性的重要组成部分,包括变量名、...

    Bug书写规范V1(1).zip程序开发文档软件开发文技术档下载

    Bug书写规范V1(1).zip程序开发文档软件开发文技术档下载Bug书写规范V1(1).zip程序开发文档软件开发文技术档下载Bug书写规范V1(1).zip程序开发文档软件开发文技术档下载Bug书写规范V1(1).zip程序开发文档软件开发文...

    软件工程文档书写规范

    本压缩包文件“软件工程文档书写规范”包含了软件工程中的关键文档,包括需求说明书、概要说明书和详细设计说明书。这些文档是软件开发生命周期中的核心组成部分,对于确保项目的顺利进行和产品质量至关重要。 **...

    软件开发文档书写标准

    "软件开发文档书写标准"详细阐述了国际通用的文档规范,旨在确保开发过程的透明度、效率和可维护性。以下将对标题和描述中涉及的关键知识点进行深入解析。 1. **软件需求文档(Software Requirements Specification...

    软件开发项目中需求文档书写规范示例

    软件开发项目中需求文档书写规范示例 本文档是关于软件开发...本文档为软件开发项目中需求文档书写规范的示例,旨在帮助开发人员更好地理解需求文档的设计和书写规范,并提供了详细的 Demo,以便更好地理解和应用。

    软件开发的文档书写格式

    本文将深入探讨15个关键的软件开发文档及其书写规范,结合GB8567-88标准,帮助你理解并掌握这些文档的重要性和格式。 1. **需求规格说明书**:定义了软件应实现的功能和非功能需求,为项目提供明确的目标。GB8567-...

    java 书写规范

    Java 代码书写规范是软件开发中非常重要的一部分,良好的代码书写规范可以提高代码的可读性、维护性和重用性。以下是 Java 代码书写规范的详细说明: 命名规范 在 Java 中,命名规范是非常重要的。包名应由一个...

    软件文档书写规范说明书

    《软件文档书写规范说明书》是指导软件开发过程中各阶段文档编写的重要参考资料,涵盖了软件生命周期中的多个关键环节。软件文档不仅仅是代码的附属品,更是保证软件质量和有效沟通的关键工具。以下将详细阐述这些...

    精心总结50多家国内外大厂的README文档的书写规范

    精心总结50多家国内外大厂的README文档的规范写法,无论大中小型公司都可以参照这个规范去写文档。适用类型:于个人或公司的开源项目,项目文档,接口文档,测试文档等文档的书写。适宜人群:无论小白还是老司机都...

    Java软件开发文档代码规范

    本知识点将根据文档内容详细介绍Java软件开发中的代码组织与风格、注解规则、命名规范以及如何编写高质量的代码注释,以确保代码的规范性和可读性。 一、代码组织与风格 Java代码组织与风格的规范有助于提高代码的...

    Android开发规范文档完整版

    根据提供的文档信息,以下是对这份Android开发规范文档中所涉及的关键知识点进行的详细解析: ### 规范目的 #### 1.1 清晰性 文档强调清晰的重要性超过简洁。这意味着在选择命名或编写API时,应优先考虑易读性和...

    Vue前端开发规范.pdf

    Vue前端开发规范 一、前端开发规范的重要性 在前端开发过程中,遵循规范是至关重要的。它不仅影响代码的维护和理解成本,而且...需要注意的是,随着项目和团队的发展,规范也需要适时更新和优化,以适应新的开发需求。

    手写输入,随手写

    总的来说,"手写输入,随手写"是一种集成了先进的图像处理、模式识别和人工智能技术的交互方式,它旨在提供与传统书写相似的体验,同时利用数字设备的优势,如无限的存储空间、便捷的搜索和分享功能。随着技术的进步...

    软件工程文档书写标准

    "软件工程文档书写标准"是指一套规范化的指导原则,旨在确保软件开发过程中的所有文档清晰、准确且一致。下面将详细阐述这一主题。 一、软件工程文档分类与内容 1. 需求规格说明书:这是软件开发的起点,详细描述...

    阿里巴巴开发规范.docx

    ### 阿里巴巴Java开发规范精要解读 #### 一、编程规约 ##### (一) 命名规约 **强制规定**:所有代码中的命名均不能以下划线`_`或美元符号`$`开始或结束。例如,`_name`、`__name`、`$Object`、`name_`、`name$`、...

Global site tag (gtag.js) - Google Analytics